Skip to content
This repository has been archived by the owner on Mar 6, 2024. It is now read-only.

vCD External Network

Jump to bottom
mac edited this page Aug 6, 2020 · 2 revisions

vCD External Network Example Usage

  1. vCD External Network States

    • Create vCD External Network
     
 - name: create vCD external network
   vcd_external_network:
    vc_name: vc.0
    port_group_names:
        - VM Network
    network_name: external-network
    gateway_ip: 10.176.3.253
    netmask: 255.255.0.0
    ip_ranges:
        - 10.176.7.68-10.176.7.69
    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
    • vc_name - Name of the underlying vCenter
    • port_group_names - list of vCenter port groups external network needs to be attached with
    • network_name - Name of the new vCD External Network
    • gateway_ip - IP address of the gateway
    • netmask - Netmask of the gateway
    • ip_ranges - list of IP ranges used for static pool allocation in the network
    • description - (Optional) Description for vCD External Network
    • primary_dns_ip - (Optional) IP address of primary DNS server
    • secondary_dns_ip - (Optional) IP address of secondary DNS Server
    • dns_suffix - (Optional) DNS suffix
    • state - (Required) "present" to create vCD External Network
    • Update vCD external network
     
 - name: update vCD external network
   vcd_external_network:
    network_name: external-network
    description: new-network-description
    new_network_name: new-network
    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
    • network_name - Name of the exisiting External Network
    • new_network_name - New name of the network
    • description - Updated description of network
    • state - (Required) "update" to update vCD External Network
    • Delete vCD external network
     
 - name: delete vCD external network
   vcd_external_network:
    network_name: test_role
    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
    • network_name - Name of network to be deleted
    • force_delete - (Optional) boolean flag to delete network forcefully
    • state - (Required) "absent" to delete vCD External Network

  2. vCD External Network Operations

    • List External Networks
     
 - name: list vCD External Networks
   vcd_external_network:
    operation: list_networks
    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
    • operation - (Required) "list_networks" to list all available External Networks
    • Add new Subnet
     
 - name: add subnet to vCD External Network
   vcd_external_network:
    network_name: new-name
    gateway_ip: 10.196.10.253
    netmask: 255.255.0.0
    ip_ranges:
        - 10.196.7.68-10.196.7.69
    operation: add_subnet
    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
    • network_name - Name of the external network
    • gateway_ip - IP address of the gateway
    • netmask - Netmask of the gateway
    • ip_ranges - list of IP ranges used for static pool allocation in the network
    • operation - (Required) "add_subnet" to add new subnet to the network
    • Add new IP Ranges
     
 - name: add new ip ranges to vCD External Network subnet
   vcd_external_network:
    network_name: new-name
    gateway_ip: 10.196.10.253
    ip_ranges:
        - 10.196.7.68-10.196.7.69
    operation: add_ip_ranges
    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
    • network_name - Name of the external network
    • gateway_ip - IP address of the gateway
    • ip_ranges - list of IP ranges used for static pool allocation in the network
    • operation - (Required) "add_ip_ranges" to add new ip ranges to the subnet
    • Modify IP Ranges
     
 - name: modify existing ip ranges inside vCD External Network subnet
   vcd_external_network:
    network_name: new-name
    gateway_ip: 10.196.10.253
    ip_ranges:
        - 10.196.7.68-10.196.7.69
    new_ip_ranges:
        - 10.196.8.68-10.196.8.69
    operation: modify_ip_ranges
    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
    • network_name - Name of the external network
    • gateway_ip - IP address of the gateway
    • ip_ranges - list of old IP ranges needs to be removed
    • new_ip_ranges - list of new IP ranges needs to be added
    • operation - (Required) "modify_ip_ranges" to modify ip ranges inside subnet
    • Delete IP Ranges
     
 - name: delete existing ip ranges inside vCD External Network subnet
   vcd_external_network:
    network_name: new-name
    gateway_ip: 10.196.10.253
    ip_ranges:
        - 10.196.8.68-10.196.8.69
    operation: delete_ip_ranges
    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
    • network_name - Name of the external network
    • gateway_ip - IP address of the gateway
    • ip_ranges - list of IP ranges needs to be removed
    • operation - (Required) "delete_ip_ranges" to delete ip ranges inside subnet
    • Enable/Disable vCD External Network Subnet
     
 - name: enable vCD External Network subnet
   vcd_external_network:
    network_name: new-name
    gateway_ip: 10.196.10.253
    enable_subnet: True
    operation: enable_subnet
 
 
     
 - name: disable vCD External Network subnet
   vcd_external_network:
    network_name: new-name
    gateway_ip: 10.196.10.253
    enable_subnet: False
    operation: enable_subnet
    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
    • network_name - Name of the external network
    • gateway_ip - IP address of the gateway
    • enable_subnet - boolean flag to enable/disable external network subnet
    • operation - (Required) "enable_subnet" to enable/disable external network subnet
    • Attach vCenter Port Group to vCD External Network
     
 - name: attach port group to vCD External Network
   vcd_external_network:
    vc_name: vc.0
    port_group_names:
        - VM Network
    network_name: new-name
    operation: attach_port_group
    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
    • vc_name - Name of the underlying vCenter
    • port_group_names - list of vCenter port groups external network needs to be attached with
    • network_name - Name of the external network
    • operation - (Required) "attach_port_group" to attach a port group to the external network
    • Detach vCenter Port Group to vCD External Network
     
 - name: detach port group to vCD External Network
   vcd_external_network:
    vc_name: vc.0
    port_group_names:
        - VM Network
    network_name: new-name
    operation: detach_port_group
    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
    • vc_name - Name of the underlying vCenter
    • port_group_names - list of vCenter port groups external network needs to be detached with
    • network_name - Name of the external network
    • operation - (Required) "detach_port_group" to detach a port group to the external network
Clone this wiki locally