Set-Org Command | Vmware PowerCLI Reference

Set-Org

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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
Org Org[] named
  • pipeline
Specifies the organization that you want to configure.
optional Description String named
Specifies a description for the organization you want to modify.
optional Enabled Boolean named
Specifies whether you want to activate or deactivate the organization. Note: This parameter is only available to Provider Administrators.
optional FullName String named
Specifies a new full name for the organization.
optional Name String named
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 deactivate the organization first. Note: This parameter is only available to Provider Administrators.
optional ProgressAction ActionPreference named
optional Server CIServer[] named
Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.

Output

VMware.VimAutomation.Cloud.Types.V1.Org

Examples

Example 1

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

Deactivates 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.

Related Commands

Org

This cmdlet retrieves cloud organizations.

This cmdlet creates a new organization.

This cmdlet removes the specified organization.

This cmdlet modifies the configuration of the specified organization.

OrgVdc

This cmdlet retrieves organization vDCs.

This cmdlet creates an organization virtual datacenter (vDC).

This cmdlet removes organization virtual datacenters (vDCs).

This cmdlet modifies the configuration of the specified organization virtual datacenter (vDC).

OrgVdcNetwork

This cmdlet retrieves organization vDC networks.

This cmdlet creates a new organization VDC network on a vCloud Director server.

This cmdlet deletes the specified organization VDC network.

This cmdlet modifies the configuration of the specified organization network.