Skip to content

Latest commit

 

History

History
116 lines (85 loc) · 2.03 KB

Remove-AnsibleToken.md

File metadata and controls

116 lines (85 loc) · 2.03 KB
external help file Module Name online version schema
Jagabata.psm.dll-Help.xml
Jagabata.psm
2.0.0

Remove-AnsibleToken

SYNOPSIS

Remove an AccessToken.

SYNTAX

Remove-AnsibleToken [-Id] <UInt64> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Remove an AccessToken.

Implements following Rest API:

  • /api/v2/tokens/{id}/ (DELETE)

EXAMPLES

Example 1

PS C:\> Remove-AnsibleToken -Id 3

PARAMETERS

-Force

Don't confirm. (Ignore -Confirm and -WhatIf)

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Id

AccessToken ID to be removed.

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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

-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

CommonParameters

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

INPUTS

System.UInt64

AccessToken ID.

OUTPUTS

None

NOTES

RELATED LINKS

Get-AnsibleToken

Find-AnsibleToken

New-AnsibleToken

Update-AnsibleToken