Skip to content

Latest commit

 

History

History
112 lines (83 loc) · 2.02 KB

Remove-AnsibleAdHocCommandJob.md

File metadata and controls

112 lines (83 loc) · 2.02 KB
external help file Module Name online version schema
Jagabata.psm.dll-Help.xml
Jagabata.psm
2.0.0

Remove-AnsibleAdHocCommandJob

SYNOPSIS

Remove an AdHocCommand job.

SYNTAX

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

DESCRIPTION

Remove an AdHocCommand job.

Implements following Rest API:

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

EXAMPLES

Example 1

PS C:\> Remove-AnsibleAdHocCommandJob -Id 30

PARAMETERS

-Force

Ignore confirmination.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Id

AdHocCommand job 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

AdHocCommand job ID.

OUTPUTS

None

NOTES

RELATED LINKS

Get-AnsibleAdHocCommandJob

Find-AnsibleAdHocCommandJob