| external help file | Module Name | online version | schema |
|---|---|---|---|
Jagabata.psm.dll-Help.xml |
Jagabata.psm |
2.0.0 |
Disable a NotificationTemplate.
Disable-AnsibleNotificationTemplate [-Id] <UInt64> [-For] <IResource> [-On] <String[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
Disable notification at the specified timings (Started, Success, Error and Approval)
for the target resource (Organization, Project, InventorySource, JobTemplate, SystemJobTemplate and WorkflowJobTemplate).
The timing Approval is only available for Organization and WorkflowJobTemplate.
Implements following Rest API:
/api/v2/organizations/{id}/notification_templates_approvals/(POST)/api/v2/organizations/{id}/notification_templates_error/(POST)/api/v2/organizations/{id}/notification_templates_started/(POST)/api/v2/organizations/{id}/notification_templates_success/(POST)/api/v2/projects/{id}/notification_templates_error/(POST)/api/v2/projects/{id}/notification_templates_started/(POST)/api/v2/projects/{id}/notification_templates_success/(POST)/api/v2/inventory_sources/{id}/notification_templates_error/(POST)/api/v2/inventory_sources/{id}/notification_templates_started/(POST)/api/v2/inventory_sources/{id}/notification_templates_success/(POST)/api/v2/job_templates/{id}/notification_templates_error/(POST)/api/v2/job_templates/{id}/notification_templates_started/(POST)/api/v2/job_templates/{id}/notification_templates_success/(POST)/api/v2/system_job_templates/{id}/notification_templates_error/(POST)/api/v2/system_job_templates/{id}/notification_templates_started/(POST)/api/v2/system_job_templates/{id}/notification_templates_success/(POST)/api/v2/workflow_job_templates/{id}/notification_templates_approvals/(POST)/api/v2/workflow_job_templates/{id}/notification_templates_error/(POST)/api/v2/workflow_job_templates/{id}/notification_templates_started/(POST)/api/v2/workflow_job_templates/{id}/notification_templates_success/(POST)
PS C:\> Disable-AnsibleNotificationTemplate -Id 5 -For (Get-AnsibleJobTemplate -Id 3) -On Success,ErrorThe target resource to be enabled the notification.
The available resources:
OrganizationProjectInventorySourceJobTemplateSystemJobTemplateWorkflowJobTemplate
Type: IResource
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseNotificationTemplate ID.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseTiming of notifications to be enabled.
Available timings:
StartedSuccessErrorApproval(only forOrganizationandWorkflowJobTemplateresource)
Type: String[]
Parameter Sets: (All)
Aliases:
Accepted values: Started, Success, Error, Approval
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts 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: FalseShows 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: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
NotificationTemplate ID.
Get-AnsibleNotificationTemplate
Find-AnsibleNotificationTemplate
New-AnsibleNotificationTemplate
Enable-AnsibleNotificationTemplate