PowerCLI Reference

Set-Org

Synopsis

This cmdlet modifies the configuration of the specified organization.

Syntax

Set-Org [-Org] <Org[]> [-Description <String>] [-Enabled <Boolean>] [-FullName <String>] [-Name <String>] [-Server <CIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-Org
New-Org
Remove-Org

Detailed Description

This cmdlet modifies the configuration of the specified organization.

Note: This cmdlet is available only to Provider Administrators. To ensure backward compatibility, PowerCLI provides limited support for this cmdlet for Tenant Administrators against vCloud Director 5.1 environments. When you develop new tenant scripts for vCloud Director 5.1 environments, do not use this cmdlet.

Parameters

Name	Type	Description	Required?	Pipeline Input
Org	Org[]	Specifies the organization that you want to configure.	true	True (ByValue)
Confirm	SwitchParameter	If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.	false	False
Description	String	Specifies a description for the organization you want to modify.	false	False
Enabled	Boolean	Specifies whether you want to enable or disable the organization. Note: This parameter is only available to Provider Administrators.	false	False
FullName	String	Specifies a new full name for the organization.	false	False
Name	String	Specifies a new unique name identifier for the organization. To set a new unique name identifier for organizations in a vCloud Director 5.1 environment, you need to disable the organization first. Note: This parameter is only available to Provider Administrators.	false	False
Server	CIServer[]	Specifies the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.	false	False
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	False

Return Type

Zero or more modified Organization objects

Notes

Examples

-------------------------- Example 1 --------------------------

Get-Org -Name "MyOrg" | Set-Org -Enabled:$false | Set-Org -Name "MyOrgNewName" -FullName "MyOrgFullName2" -Description "Update my Org"

Disables an organization and modifies its unique name identifier, its full name and its description.

-------------------------- Example 2 --------------------------

Get-Org -Name 'MyOrg' | Set-Org -FullName 'MyNewOrgFullName' -Description "This is my updated organization."

Updates the full name and the description of the specified organization.

Note: This example is supported only on vCloud Director 1.5.x environments.