Get-VmcOrganization
This cmdlet retrieves an organization from the VMware Cloud environment.
Syntax
[-ListAvailable
]
[-Name
< String[] > ]
[-ProgressAction
< ActionPreference > ]
[-Server
< VmcServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | ListAvailable | SwitchParameter | named |
|
Specifies that you want to retrieve the available organizations. By default, the cmdlet retrieves only the organizations that the user has an active connection to. |
| optional | Name | String[] | named |
|
Specifies the names of the SDDCs you want to retrieve. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | VmcServer[] | named |
|
Specifies the VMware Cloud on AWS 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 the Connect-Vmc cmdlet. |
[-Id
< String[] > ]
[-ProgressAction
< ActionPreference > ]
[-Server
< VmcServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Id | String[] | named |
|
Specifies the IDs of the organizations you want to retrieve. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | VmcServer[] | named |
|
Specifies the VMware Cloud on AWS 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 the Connect-Vmc cmdlet. |
Output
VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcOrganizationExamples
Example 1
Get-VmcOrganization -Name "OrganizationName"
Retrieves the organization named "SddcName".
Example 2
Get-VmcOrganization -Id "OrganizationId"
Retrieves the organization with an "OrganizationId" ID.
Example 3
Get-VmcOrganization -ListAvailable
Retrieves all available organizations.
Related Commands
VmcOrganization
This cmdlet retrieves an organization from the VMware Cloud environment.