Disable-PASPlatform

Disable-PASPlatform

SYNOPSIS

Deactivates a platform.

SYNTAX

targets

Disable-PASPlatform [-TargetPlatform] -ID <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]

groups

Disable-PASPlatform [-GroupPlatform] -ID <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]

rotationalGroups

Disable-PASPlatform [-RotationalGroup] -ID <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Disables, target, group or rotational group platform.

EXAMPLES

EXAMPLE 1

Disable-PASPlatform -TargetPlatform -ID 53

Disables Target Platform with ID of 53

EXAMPLE 2

Disable-PASPlatform -GroupPlatform -id 64

Disables Group Platform with ID of 64

EXAMPLE 3

Disable-PASPlatform -RotationalGroup -id 65

Disables Rotational Group Platform with ID of 65

PARAMETERS

-TargetPlatform

Specify if ID relates to Target platform

Type: SwitchParameter
Parameter Sets: targets
Aliases:

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

-GroupPlatform

Specify if ID relates to Group platform

Type: SwitchParameter
Parameter Sets: groups
Aliases:

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

-RotationalGroup

Specify if ID relates to Rotational Group platform

Type: SwitchParameter
Parameter Sets: rotationalGroups
Aliases:

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

-ID

The unique ID number of the platform to disable.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

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.

INPUTS

OUTPUTS

NOTES

PAS 11.4 minimum

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

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

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

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

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