Skip to main content

Get-LXCASchedule

This cmdlet retrieves information about one or more job schedules.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Get-LXCASchedule [-Connection LXCAConnection]
                 [-ScheduleName String]
                 [CommonParameter]

Get-LXCASchedule [-Connection LXCAConnection]
                 [-ScheduleType  String]
                 [CommonParameter]

Parameters​

-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.
-ScheduleName String
Specifies the name of the job schedule. If a name is not specified, the cmdlet returns information about all job schedules.
-ScheduleType String
Specifies the type of job schedule. If type is specified, the cmdlet returns information about all job schedule of the specified type. If a type is not specified, the cmdlet returns information about all job schedules.

You can specify one of the following values.

  • One Time. Returns information about all job schedule that run one time (immediately or at a later time).

  • Recurring. Returns information about all job schedule that run on a recurring basis.

  • Triggered. Returns information about all job schedule that run are trigged when a specific event occurs.

CommonParameters
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.

Results​

This cmdlet returns one or more ScheduleObject objects

Examples​

  • The following example retrieves information about all job schedules.
    $cred = Get-Credential
    Connect-LXCA -Host 192.0.2.0 -Credential $cred

    $schedules = Get-LXCASchedule

    Disconnect-LXCA
  • The following example retrieves information about a specific job schedule.
    $cred = Get-Credential
    Connect-LXCA -Host 192.0.2.0 -Credential $cred

    Get-LXCASchedule –ScheduleName $name

    Disconnect-LXCA
  • The following example retrieves information about all reoccurring job schedule.
    $cred = Get-Credential
    Connect-LXCA -Host 192.0.2.0 -Credential $cred

    Get-LXCASchedule -ScheduleType Recurring

    Disconnect-LXCA