Remove-Org

This cmdlet removes the specified organization. The organization must be disabled and must not contain any child objects. To automatically disable the organization before removal, set the Force parameter. Note: This cmdlet is only availabe to Provider Administrators.

Syntax

-Org  <Org[]>
[-Force]
[-Server  <CIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Org
Org[] named
  • pipeline
  • Specifies the organization that you want to remove.
    optional
    Force
    SwitchParameter named Indicates that the organization will be removed even if it is enabled. Setting the Force parameter will automatically disable the organization if it is enabled.
    optional
    Server
    CIServer[] named 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.

    Output

    Examples


    Example 1

    Get-Org "MyOrg" | Remove-Org

    Removes the MyOrg organization.

    Example 2

    Get-Org "MyEnabledOrg" | Remove-Org -Force

    Removes an enabled organization by automatically disabling it before deletion.

    Example 3

    Remove-Org -Org "MyOrg*"

    Removes all disabled organizations that have names starting with "MyOrg".

    Related Commands

    Feedback

    Was this page helpful?