Skip to content

Latest commit

 

History

History
167 lines (125 loc) · 3 KB

Update-AnsibleOrganization.md

File metadata and controls

167 lines (125 loc) · 3 KB
external help file Module Name online version schema
Jagabata.psm.dll-Help.xml
Jagabata.psm
2.0.0

Update-AnsibleOrganization

SYNOPSIS

Update an Organization.

SYNTAX

Update-AnsibleOrganization [-Id] <UInt64> [-Name <String>] [-Description <String>] [-MaxHosts <UInt32>]
 [-DefaultEnvironment <UInt64>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Update an Organization.

Implements following Rest API:

  • /api/v2/organizations/{id}/ (PATCH)

EXAMPLES

Example 1

PS C:\> Update-AnsibleOrganization -Id 2 -Name "ChangedName"

Change the name for the Organization of Id 2.

PARAMETERS

-DefaultEnvironment

ExecutionEnvironment ID.

Tip

Specify 0 or $null if want to set empty.

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-Description

Optional description of the Organization.

Type: String
Parameter Sets: (All)
Aliases:

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

-Id

Organization ID to be updated.

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-MaxHosts

Maximum number of hosts allowed to be managed by the Organization.

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-Name

Name of the Organization.

Type: String
Parameter Sets: (All)
Aliases:

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

-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

None

OUTPUTS

Jagabata.Resources.Organization

Updated Organization object.

NOTES

RELATED LINKS

Get-AnsibleOrganization

Find-AnsibleOrganization

New-AnsibleOrganization

Remove-AnsibleOrganization