Name
Get-JobSchedulerInventory
SYNOPSIS
Returns the JobScheduler Master inventory
SYNTAX
Get-JobSchedulerInventory [[-Url] <Uri>] [[-InputFile] <String>] [[-OutputFile] <String>] [-Append] [<CommonParameters>]
DESCRIPTION
The cmdlet returns the inventory of JobScheduler Master instances
including information about related Agent instances.
PARAMETERS
Url
-Url <Uri>
Specifies the URL for which a Master is available. Any Agents configured for this Master
are added to the inventory output.
Both parameters -Url and -InputFile cannot be used at the same time.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
InputFile
-InputFile <String>
Specifies the location of a simple text file that includes the URLs
of JobScheduler Master instances.
Each Master URL is expected in a separate line, e.g.
http://host1:4444
http://host2:4444
Both parameters -Url and -InputFile cannot be used at the same time.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
OutputFile
-OutputFile <String>
Specifies the location of an output file in XML format.
The output file includes the inventory for any Master instance specified.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Append
-Append <SwitchParameter>
Specifies that contents from an existing output file is preserved
and that the inventory information is added.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $inventory = Get-JobSchedulerInventory http://localhost:4444
Returns the inventory for the specified JobScheduler Master instance.
-------------------------- EXAMPLE 2 --------------------------
PS > $inventory = Get-JobSchedulerInventory http://localhost:4444 -OutputFile /tmp/inventory.xml
Returns the inventory for the specified JobScheduler Master instance and creates an XML output file that includes the inventory.
-------------------------- EXAMPLE 3 --------------------------
PS > $inventory = Get-JobSchedulerInventory -InputFile /tmp/inventory.csv -OutputFile /tmp/inventory.xml
Reads the input file "/tmp/inventory.csv" that includes a number of Master URLs. The cmdlets checks the inventory for each Master specified and creates an XML output file that includes the inventory.
-------------------------- EXAMPLE 4 --------------------------
PS > $instances = @( 'http://localhost:4444', 'http://localhost:4454' )
$inventory = $instances | Get-JobSchedulerInventory -OutputFile /tmp/inventory.xml