Get-PASPlatform

Get-PASPlatform

SYNOPSIS

Retrieves details of Vault platforms.

SYNTAX

targets (Default)

Get-PASPlatform [-Active <Boolean>] [-SystemType <String>] [-PeriodicVerify <Boolean>]
 [-ManualVerify <Boolean>] [-PeriodicChange <Boolean>] [-ManualChange <Boolean>]
 [-AutomaticReconcile <Boolean>] [-ManualReconcile <Boolean>] [<CommonParameters>]

platforms

Get-PASPlatform [-Active <Boolean>] [-PlatformType <String>] [-Search <String>] [<CommonParameters>]

platform-details

Get-PASPlatform -PlatformID <String> [<CommonParameters>]

dependents

Get-PASPlatform [-DependentPlatform] [<CommonParameters>]

groups

Get-PASPlatform [-GroupPlatform] [<CommonParameters>]

rotationalGroups

Get-PASPlatform [-RotationalGroup] [<CommonParameters>]

DESCRIPTION

Request platform configuration information from the Vault.

Default operation requires minimum version of 11.4

11.4+ can return details of target, dependent, group & rotational group platforms, with additional filters available for target group queries.

11.1+ can return details of all target platforms.

Limited filters can be used to retrieve a subset of the platforms For 9.10+, the “PlatformID” parameter is used to retrieve details of a single specified platform from the Vault.

The output contained under the “Details” property differs depending on which method (9.10+,11.1+ or 11.4+) is used, and which platform type is queried.

Note: When specifying PlatformID:

  • if the platform properties contain a semicolon (‘;’), the API may not return the complete value.
  • noted for ChangeCommand, ReconcileCommand & ConnectionCommand properties

EXAMPLES

EXAMPLE 1

Get-PASPlatform

Return details of all platforms

Minimum required version 11.4

EXAMPLE 2

Get-PASPlatform -Active $true

Get all active platforms

Minimum required version 11.4

EXAMPLE 3

Get-PASPlatform -Active $true -Search "WIN_"

Get active platforms matching search string “WIN_”

Minimum required version 11.1

EXAMPLE 4

Get-PASPlatform -PlatformID "CyberArk"

Get details of specific platform CyberArk

Minimum required version 9.10

EXAMPLE 5

Get-PASPlatform -GroupPlatform

Get details of all group platforms

Minimum required version 11.4

EXAMPLE 6

Get-PASPlatform -RotationalGroup

Get details of all rotational group platforms

Minimum required version 11.4

EXAMPLE 7

Get-PASPlatform -DependentPlatform

Get details of all dependent platforms

Minimum required version 11.4

EXAMPLE 8

Get-PASPlatform -Active $false -SystemType Windows

Get details of all deactivated Windows platforms

Minimum required version 11.4

EXAMPLE 9

Get-PASPlatform -Active $true -SystemType '*NIX' -AutomaticReconcile $true

Get details of all active Unix platforms configured for automatic reconciliation.

Minimum required version 11.4

EXAMPLE 10

Get-PASPlatform -PlatformType Regular -Search "WIN_"

Get platforms matching search string “WIN_”

Minimum required version 11.1

EXAMPLE 11

Get-PASPlatform -PlatformType Regular -Search "WIN_" -Active $true

Get active platforms matching search string “WIN_”

Minimum required version 11.1

PARAMETERS

-Active

Filter active/inactive platforms

Minimum required version 11.1

Type: Boolean
Parameter Sets: targets, platforms
Aliases:

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

-PlatformType

Filter regular/group platforms

Minimum required version 11.1

Type: String
Parameter Sets: platforms
Aliases:

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

Filter platform by search pattern

Minimum required version 11.1

Type: String
Parameter Sets: platforms
Aliases:

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

-PlatformID

The unique ID/Name of the platform.

Minimum required version 9.10

Type: String
Parameter Sets: platform-details
Aliases: Name

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

-DependentPlatform

Specify to return details of dependent platforms

Minimum required version 11.4

Type: SwitchParameter
Parameter Sets: dependents
Aliases:

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

-GroupPlatform

Specify to return details of group platforms

Minimum required version 11.4

Type: SwitchParameter
Parameter Sets: groups
Aliases:

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

-RotationalGroup

Specify to return details of rotational group platforms

Minimum required version 11.4

Type: SwitchParameter
Parameter Sets: rotationalGroups
Aliases:

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

-SystemType

Filter target platforms for specific system type

Minimum required version 11.4

Type: String
Parameter Sets: targets
Aliases:

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

-PeriodicVerify

Filter target platforms by periodic verification configuration

Minimum required version 11.4

Type: Boolean
Parameter Sets: targets
Aliases:

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

-ManualVerify

Filter target platforms by manual verification configuration

Minimum required version 11.4

Type: Boolean
Parameter Sets: targets
Aliases:

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

-PeriodicChange

Filter target platforms by periodic change configuration

Minimum required version 11.4

Type: Boolean
Parameter Sets: targets
Aliases:

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

-ManualChange

Filter target platforms by manual change configuration

Minimum required version 11.4

Type: Boolean
Parameter Sets: targets
Aliases:

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

-AutomaticReconcile

Filter target platforms by automatic reconciliation configuration

Minimum required version 11.4

Type: Boolean
Parameter Sets: targets
Aliases:

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

-ManualReconcile

Filter target platforms by manual reconciliation configuration

Minimum required version 11.4

Type: Boolean
Parameter Sets: targets
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
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

Minimum CyberArk version 9.10

CyberArk version 11.1 required for Active, PlatformType & Search parameters.

CyberArk version 11.4 required for extended filters for target platforms, and requests for dependent, group & rotational group platforms

https://pspas.pspete.dev/commands/Get-PASPlatform

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/SDK/rest-api-get-platforms.htm

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/GetPlatformDetails.htm

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/SDK/rest-api-get-target-platforms.htm

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/SDK/rest-api-get-dependent-platforms.htm

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/SDK/rest-api-get-group-platforms.htm

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/SDK/rest-api-get-rotational-group-platforms.htm