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

User Example Usage

  1. User States

    • Create User
     
 - name: create user
   vcd_user:
    username: "test_user"
    userpassword: test_password
    role_name: "Organization Administrator"
    org_name: test_org_name
    full_username: "test_admin_user"
    description: "admin test user"
    email: "[email protected]"
    telephone: "12345678"
    im: "i_m_val"
    is_enabled: "false"
    stored_vm_quota: 5
    deployed_vm_quota: 5
    is_alert_enabled: "true"
    is_external: "false"
    is_default_cached: "false"
    is_group_role: "false"
    alert_email_prefix: "test"
    alert_email: "[email protected]"
    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
    • username - (Required) The username of the user
    • userpassword - (Required) The password of the user (must be at least 6 characters long)
    • role_name - (Required) User role name
    • org_name - (Required) Org name for which user is being created
    • full_username - (Optional) The full name of the user
    • description - (Optional) The description for the User
    • email - (Optional) The email of the user
    • telephone - (Optional) The telephone of the user
    • im - (Optional) The im address of the user
    • is_enabled - (Optional) true/false Enable user. The default value is false.
    • stored_vm_quota - (Optional) The quota of vApps that this user can store. The default value is 0.
    • deployed_vm_quota - (Optional) The quota of vApps that this user can deploy concurrently. The default value is 0.
    • is_alert_enabled - (Optional) true/false The alert email address. The default value is false.
    • is_external - (Optional) true/false Indicates if user is imported from an external source. The default value is false.
    • is_default_cached - (Optional) true/false Indicates if user should be cached. The default value is false.
    • is_group_role - (Optional) true/false Indicates if the user has a group role. The default value is false.
    • alert_email_prefix - (Optional) The string to prepend to the alert message subject line
    • alert_email - (Optional) The alert email address
    • state == "present" (Required) to create user
    • Update User
     
 - name: update user
   vcd_user:
    username: "test_user"
    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
    • username - (Required) username of the user
    • is_enabled - (Required) true/false enable/disable the user
    • state == "update" (Required) to update user
    • Delete User
     
 - name: delete user
   vcd_user:
    username: "test_user"
    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
    • username - (Required) username of the user
    • state == "absent" (Required) to delete user
⚠️ **GitHub.com Fallback** ⚠️