Get-ITGlueOperatingSystem

SYNOPSIS

List or show all operating systems

SYNTAX

Index (Default)

Get-ITGlueOperatingSystem [-FilterName <String>] [-Sort <String>] [-PageNumber <Int64>] [-PageSize <Int32>]
 [-AllResults] [<CommonParameters>]

Show

Get-ITGlueOperatingSystem -ID <Int64> [<CommonParameters>]

DESCRIPTION

The Get-ITGlueOperatingSystem cmdlet returns a list of supported operating systems or the details of a defined operating system

This function can call the following endpoints: Index = /operating_systems

Show =  /operating_systems/:id

EXAMPLES

EXAMPLE 1

Get-ITGlueOperatingSystem

Returns the first 50 operating system results from your ITGlue account

EXAMPLE 2

Get-ITGlueOperatingSystem -ID 8765309

Returns the operating systems with the defined id

EXAMPLE 3

Get-ITGlueOperatingSystem -PageNumber 2 -PageSize 10

Returns the first 10 results from the second page for operating systems in your ITGlue account

PARAMETERS

-FilterName

Filter by operating system name

Type: String
Parameter Sets: Index
Aliases: filter_name

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sort

Sort results by a defined value

Allowed values: ‘name’, ‘id’, ‘created_at’, ‘updated_at’, ‘-name’, ‘-id’, ‘-created_at’, ‘-updated_at’

Type: String
Parameter Sets: Index
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageNumber

Return results starting from the defined number

Type: Int64
Parameter Sets: Index
Aliases: page_number

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PageSize

Number of results to return per page

The maximum number of page results that can be requested is 1000

Type: Int32
Parameter Sets: Index
Aliases: page_size

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-ID

Get an operating system by id

Type: Int64
Parameter Sets: Show
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-AllResults

Returns all items from an endpoint

This can be used in unison with -PageSize to limit the number of sequential requests to the API

Type: SwitchParameter
Parameter Sets: Index
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

N/A

https://celerium.github.io/ITGlue-PowerShellWrapper/site/OperatingSystems/Get-ITGlueOperatingSystem.html

https://api.itglue.com/developer/#operating-systems-index