Get-Agent

SYNOPSIS

Get agent

SYNTAX

Get-Agent
	[-Id] <Object[]>
	[-SkipChildrenNames]
	[-WithChildren]
	[-WithChildrenCount]
	[-WithGroups]
	[-WithParents]
	[-WithLatestValues]
	[-Raw]
	[-OutputFile <String>]
	[-OutputFileRaw <String>]
	[-OutputTemplate <String>]
	[-Proxy]
	[-NoProxy]
	[-Timeout <String>]
	[-NoProgress]
	[-Session <String>]
	[-SessionUsername <String>]
	[-SessionPassword <String>]
	[-Output <String>]
	[-View <String>]
	[-AsHashTable]
	[-AsPSObject]
	[-Flatten]
	[-Compact]
	[-NoColor]
	[-Cache]
	[-NoCache]
	[-CacheTTL <String>]
	[-Insecure]
	[-Help]
	[-Examples]
	[-Confirm]
	[-ConfirmText <String>]
	[-WithError]
	[-SilentStatusCodes <String>]
	[-SilentExit]
	[-Dry]
	[-DryFormat <String>]
	[-Workers <Int32>]
	[-Delay <String>]
	[-DelayBefore <String>]
	[-MaxJobs <Int32>]
	[-Progress]
	[-AbortOnErrors <Int32>]
	[-NoLog]
	[-LogMessage <String>]
	[-Select <String[]>]
	[-Filter <String[]>]
	[-Header <String[]>]
	[-CustomQueryParam <String[]>]
	[<CommonParameters>]

DESCRIPTION

Get an agent's managed object representation

EXAMPLES

EXAMPLE 1

Get-Agent -Id $agent.id

Get agent by id

EXAMPLE 2

Get-Agent -Id $agent.name

Get agent by name

PARAMETERS

-Id

Agent ID (required)

Type: Object[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-SkipChildrenNames

Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WithChildren

Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WithChildrenCount

When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices)

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WithGroups

When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WithParents

Include a flat list of all parents and grandparents of the given object

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WithLatestValues

(FEATURE_PREVIEW) Include c8y_LatestMeasurements fragment, which contains the latest measurement values reported by the device to the platform

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AbortOnErrors

Abort batch when reaching specified number of errors

Type: Int32
Parameter Sets: (All)
Aliases:

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

-AsHashTable

Return output as PowerShell Hashtables

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AsPSObject

Return output as PowerShell PSCustomObjects

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Cache

Enable cached responses

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-CacheTTL

Cache time-to-live (TTL) as a duration, i.e. 60s, 2m

Type: String
Parameter Sets: (All)
Aliases:

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

-Compact

Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal

Type: SwitchParameter
Parameter Sets: (All)
Aliases: Compress

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

-Confirm

Prompt for confirmation

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ConfirmText

Custom confirmation text

Type: String
Parameter Sets: (All)
Aliases:

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

-CustomQueryParam

add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Delay

delay after each request. It accepts a duration, i.e. 1ms, 0.5s, 1m etc.

Type: String
Parameter Sets: (All)
Aliases:

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

-DelayBefore

delay before each request. It accepts a duration, i.e. 1ms, 0.5s, 1m etc.

Type: String
Parameter Sets: (All)
Aliases:

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

-Dry

Dry run. Don't send any data to the server

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-DryFormat

Dry run output format. i.e. json, dump, markdown or curl

Type: String
Parameter Sets: (All)
Aliases:

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

-Examples

Show examples for the current command

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Filter

Apply a client side filter to response before returning it to the user

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Flatten

flatten json output by replacing nested json properties with properties where their names are represented by dot notation

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

custom headers. i.e. --header 'Accept: value, AnotherHeader: myvalue'

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Help

Show command help

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Insecure

Allow insecure server connections when using SSL

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-LogMessage

Add custom message to the activity log

Type: String
Parameter Sets: (All)
Aliases:

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

-MaxJobs

Maximum number of jobs. 0 = unlimited (use with caution!)

Type: Int32
Parameter Sets: (All)
Aliases:

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

-NoCache

Force disabling of cached responses (overwrites cache setting)

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-NoColor

Don't use colors when displaying log entries on the console

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-NoLog

Disables the activity log for the current command

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-NoProgress

Disable progress bars

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-NoProxy

Ignore the proxy settings

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Output

Output format i.e. table, json, csv, csvheader

Type: String
Parameter Sets: (All)
Aliases:

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

-OutputFile

Save JSON output to file (after select/view)

Type: String
Parameter Sets: (All)
Aliases:

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

-OutputFileRaw

Save raw response to file (before select/view)

Type: String
Parameter Sets: (All)
Aliases:

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

-OutputTemplate

jsonnet template to apply to the output

Type: String
Parameter Sets: (All)
Aliases:

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

-Progress

Show progress bar. This will also disable any other verbose output

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Proxy

Proxy setting, i.e. http://10.0.0.1:8080

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Raw

Show raw response. This mode will force output=json and view=off

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Select

Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Session

Session configuration

Type: String
Parameter Sets: (All)
Aliases:

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

-SessionPassword

Override session password

Type: String
Parameter Sets: (All)
Aliases:

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

-SessionUsername

Override session username. i.e. peter or t1234/peter (with tenant)

Type: String
Parameter Sets: (All)
Aliases:

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

-SilentExit

Silent status codes do not affect the exit code

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-SilentStatusCodes

Status codes which will not print out an error message

Type: String
Parameter Sets: (All)
Aliases:

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

-Timeout

Request timeout. It accepts a duration, i.e. 1ms, 0.5s, 1m etc.

Type: String
Parameter Sets: (All)
Aliases:

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

-View

Use views when displaying data on the terminal. Disable using --view off

Type: String
Parameter Sets: (All)
Aliases:

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

-WithError

Errors will be printed on stdout instead of stderr

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Workers

Number of workers

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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.

SYNOPSIS​

SYNTAX​

DESCRIPTION​

EXAMPLES​

EXAMPLE 1​

EXAMPLE 2​

PARAMETERS​

-Id​

-SkipChildrenNames​

-WithChildren​

-WithChildrenCount​

-WithGroups​

-WithParents​

-WithLatestValues​

-AbortOnErrors​

-AsHashTable​

-AsPSObject​

-Cache​

-CacheTTL​

-Compact​

-Confirm​

-ConfirmText​

-CustomQueryParam​

-Delay​

-DelayBefore​

-Dry​

-DryFormat​

-Examples​

-Filter​

-Flatten​

-Header​

-Help​

-Insecure​

-LogMessage​

-MaxJobs​

-NoCache​

-NoColor​

-NoLog​

-NoProgress​

-NoProxy​

-Output​

-OutputFile​

-OutputFileRaw​

-OutputTemplate​

-Progress​

-Proxy​

-Raw​

-Select​

-Session​

-SessionPassword​

-SessionUsername​

-SilentExit​

-SilentStatusCodes​

-Timeout​

-View​

-WithError​

-Workers​

CommonParameters​

INPUTS​

OUTPUTS​

System.Object​

NOTES​

RELATED LINKS​