Skip to content

Latest commit

 

History

History
106 lines (75 loc) · 2.35 KB

Get-AnsibleSurveySpec.md

File metadata and controls

106 lines (75 loc) · 2.35 KB
external help file Module Name online version schema
Jagabata.psm.dll-Help.xml
Jagabata.psm
2.0.0

Get-AnsibleSurveySpec

SYNOPSIS

Retrieve Survey specifications.

SYNTAX

Get-AnsibleSurveySpec [-Type] <ResourceType> [-Id] <UInt64> [<CommonParameters>]

DESCRIPTION

Retrieve Survey specifications for JobTemplate or WorkflowJobTemplate.

Implements following Rest API:

  • /api/v2/job_templates/{id}/survey_spec/
  • /api/v2/workflow_job_templates/{id}/survey_spec/

EXAMPLES

Example 1

PS C:\> Get-AnsibleSurveySpec -Type JobTemplate -Id 10

Name Description Spec
---- ----------- ----
                 {{ Name = User, Type = Text, Variable = user_name, Default = }, …}

PARAMETERS

-Id

Datebase ID of the target resource. Use in conjection with the -Type parameter.

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-Type

Resource type name of the target. Use in conjection with the -Id parameter.

Type: ResourceType
Parameter Sets: (All)
Aliases:
Accepted values: JobTemplate, WorkflowJobTemplate

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

Jagabata.Resources.ResourceType

Input by Type property in the pipeline object.

Acceptable values:

  • JobTemplate
  • WorkflowJobTemplate

System.UInt64

Input by Id property in the pipeline object.

Database ID for the ResourceType

OUTPUTS

Jagabata.Resources.Survey

NOTES

RELATED LINKS

Register-AnsibleSurveySpec

Remove-AnsibleSurveySpec

Get-AnsibleJobTemplate

Find-AnsibleJobTemplate

Get-AnsibleWorkflowJobTemplate

Find-AnsibleWorkflowJobTemplate