vCD Org - vmware-archive/ansible-module-vcloud-director GitHub Wiki

Org Example Usage

  1. Org States

    • Create Org
    
    - name: create org
       vcd_org:
        org_name: "test_org"
        full_name: "test_org"
        is_enabled : "false"
        state: "present"
    
    
    Argument Reference
    • user - (Optional) - vCloud Director user name
    • password - (Optional) - vCloud Director password
    • org - (Optional) - vCloud Director org name to log into
    • host - (Optional) - vCloud Director host name
    • api_version - (Optional) - Pyvcloud API version
    • verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
    • org_name - (Required) name of the organization
    • full_name - (Required) full name of the organization
    • is_enabled - (Optional) enable organization if true. The default value is false
    • state == "present" (Required) to create org

    • Update Org
    
    - name: update org
      vcd_org:
       org_name: "test_org"
       is_enabled: "true"
       state: "update"
    
    
    Argument Reference
    • user - (Optional) - vCloud Director user name
    • password - (Optional) - vCloud Director password
    • org - (Optional) - vCloud Director org name to log into
    • host - (Optional) - vCloud Director host name
    • api_version - (Optional) - Pyvcloud API version
    • verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
    • org_name - (Required) name of the organization
    • is_enabled - (Required) enable organization if true. The default value is false
    • state == "update" (Required) to update org

    • Delete Org
    
    - name: delete org
      vcd_org:
       org_name: "test_org"
       force: "true"
       recursive: "true"
       state: "absent"
    
    
    Argument Reference
    • user - (Optional) - vCloud Director user name
    • password - (Optional) - vCloud Director password
    • org - (Optional) - vCloud Director org name to log into
    • host - (Optional) - vCloud Director host name
    • api_version - (Optional) - Pyvcloud API version
    • verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
    • org_name - (Required) name of the organization
    • force - (Optional) force=true along with recursive=true to remove an organization and any objects it contains, regardless of their state. The default value is None
    • recursive - (Optional) recursive=true to remove an organization and any objects it contains that are in a state that normally allows removal. The default value is None
    • state == "absent" (Required) to delete org

  2. Org Operations

    • Read Org
    
    - name: read org
      vcd_org:
       org_name: "test_org"
       operation: "read"
    
    
    Argument Reference
    • user - (Optional) - vCloud Director user name
    • password - (Optional) - vCloud Director password
    • org - (Optional) - vCloud Director org name to log into
    • host - (Optional) - vCloud Director host name
    • api_version - (Optional) - Pyvcloud API version
    • verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
    • org_name - (Required) name of the organization
    • operation == "read" (Required) to read organization

    • Add Rights
    
    - name: add rights to org
      vcd_org:
       org_name: "test_org"
       org_rights:
        - test_right_1
        - test_right_2
       operation: "add_rights"
    
    
    Argument Reference
    • user - (Optional) - vCloud Director user name
    • password - (Optional) - vCloud Director password
    • org - (Optional) - vCloud Director org name to log into
    • host - (Optional) - vCloud Director host name
    • api_version - (Optional) - Pyvcloud API version
    • verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
    • org_name - (Required) name of the organization
    • org_rights - (Required) list of rights to be added to an organization
    • operation == "add_rights" (Required) to add rights to the organization

    • Remove Rights
    
    - name: remove rights from org
      vcd_org:
       org_name: "test_org"
       org_rights:
        - test_right_1
        - test_right_2
       operation: "remove_rights"
    
    
    Argument Reference
    • user - (Optional) - vCloud Director user name
    • password - (Optional) - vCloud Director password
    • org - (Optional) - vCloud Director org name to log into
    • host - (Optional) - vCloud Director host name
    • api_version - (Optional) - Pyvcloud API version
    • verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
    • org_name - (Required) name of the organization
    • org_rights - (Required) list of rights to be remove to an organization
    • operation == "remove_rights" (Required) to remove rights from the organization

    • List Rights
    
    - name: list org rights
      vcd_org:
       org_name: "test_org"
       operation: "list_rights"
    
    
    Argument Reference
    • user - (Optional) - vCloud Director user name
    • password - (Optional) - vCloud Director password
    • org - (Optional) - vCloud Director org name to log into
    • host - (Optional) - vCloud Director host name
    • api_version - (Optional) - Pyvcloud API version
    • verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
    • org_name - (Required) name of the organization
    • operation == "list_rights" (Required) to list available rights of the organization

    • List Roles
    
    - name: list org roles
      vcd_org:
       org_name: "test_org"
       operation: "list_roles"
    
    
    Argument Reference
    • user - (Optional) - vCloud Director user name
    • password - (Optional) - vCloud Director password
    • org - (Optional) - vCloud Director org name to log into
    • host - (Optional) - vCloud Director host name
    • api_version - (Optional) - Pyvcloud API version
    • verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
    • org_name - (Required) name of the organization
    • operation == "list_roles" (Required) to list available roles of the organization
⚠️ **GitHub.com Fallback** ⚠️