saltext.vmware.modules.nsxt_ip_pools#

Salt Module to perform CRUD operations for NSX-T’s IP Address Pools

saltext.vmware.modules.nsxt_ip_pools.get(hostname, username, password, verify_ssl=True, cert=None, cert_common_name=None, cursor=None, included_fields=None, page_size=None, sort_by=None, sort_ascending=None)[source]#

Lists all IP Address pools present in the NSX-T Manager

CLI Example:

salt vm_minion nsxt_ip_pools.get hostname=nsxt-manager.local username=admin ...
hostname

The host name of NSX-T manager

username

Username to connect to NSX-T manager

password

Password to connect to NSX-T manager

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

cert

(Optional) Path to the SSL client certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.

cert_common_name

(Optional) By default, the hostname parameter and the common name in certificate is compared for host name verification. If the client certificate common name and hostname do not match (in case of self-signed certificates), specify the certificate common name as part of this parameter. This value is then used to compare against

cursor

(Optional) Opaque cursor to be used for getting next page of records (supplied by current result page)

included_fields

(Optional) Comma separated list of fields that should be included in query result

page_size

(Optional) Maximum number of results to return in this page

sort_by

(Optional) Field by which records are sorted

sort_ascending

(Optional) Boolean value to sort result in ascending order

saltext.vmware.modules.nsxt_ip_pools.get_by_display_name(hostname, username, password, display_name, verify_ssl=True, cert=None, cert_common_name=None)[source]#

Gets IP Address pool present in the NSX-T Manager with given name.

CLI Example:

salt vm_minion nsxt_ip_pools.get_by_display_name hostname=nsxt-manager.local username=admin ...
hostname

The host name of NSX-T manager

username

Username to connect to NSX-T manager

password

Password to connect to NSX-T manager

display_name

The name of IP Address pool to fetch

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

cert

(Optional) Path to the SSL client certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.

cert_common_name

(Optional) By default, the hostname parameter and the common name in certificate is compared for host name verification. If the client certificate common name and hostname do not match (in case of self-signed certificates), specify the certificate common name as part of this parameter. This value is then used to compare against

saltext.vmware.modules.nsxt_ip_pools.create(hostname, username, password, verify_ssl=True, cert=None, cert_common_name=None, display_name=None, description=None, tags=None, subnets=None, ip_release_delay=None)[source]#

Creates an IP Address pool with given specifications

CLI Example:

salt vm_minion nsxt_ip_pools.create hostname=nsxt-manager.local username=admin ...
hostname

The host name of NSX-T manager

username

Username to connect to NSX-T manager

password

Password to connect to NSX-T manager

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

cert

(Optional) Path to the SSL client certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.

cert_common_name

(Optional) By default, the hostname parameter and the common name in certificate is compared for host name verification. If the client certificate common name and hostname do not match (in case of self-signed certificates), specify the certificate common name as part of this parameter. This value is then used to compare against

display_name

The name using which IP Address Pool will be created. If not provided then pool id will be used as display name

description

(Optional) description for the IP Address Pool

tags

(Optional) Opaque identifiers meaningful to the API user. Maximum 30 tags can be associated:

tags='[
    {
        "tag": "<tag-key-1>"
        "scope": "<tag-value-1>"
    },
    {
        "tag": "<tag-key-2>"
        "scope": "<tag-value-2>"
    }
]'
subnets

(Optional) The collection of one or more subnet objects in a pool. Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets.

subnets='[
    {
        "cidr": "cidr_value",
        "gateway_ip": "gateway_ip_value",
        "dns_nameservers": [
            "dns_nameserver1",
            "dns_nameserver2"
        ],
        "allocation_ranges": [
            {
                "start": "IP-Address-Range-start",
                "end": "IP-Address-Range-end"
            }
        ]
    }
]'
ip_release_delay

(Optional) Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins - configured on NSX device).

saltext.vmware.modules.nsxt_ip_pools.update(ip_pool_id, display_name, revision, hostname, username, password, verify_ssl=True, cert=None, cert_common_name=None, description=None, tags=None, subnets=None, ip_release_delay=None)[source]#

Updates an IP Address pool of display name with given specifications, All the fields for which no value is provided will be set to null

CLI Example:

salt vm_minion nsxt_ip_pools.update hostname=nsxt-manager.local username=admin ...
hostname

The host name of NSX-T manager

username

Username to connect to NSX-T manager

password

Password to connect to NSX-T manager

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

cert

(Optional) Path to the SSL client certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.

cert_common_name

(Optional) By default, the hostname parameter and the common name in certificate is compared for host name verification. If the client certificate common name and hostname do not match (in case of self-signed certificates), specify the certificate common name as part of this parameter. This value is then used to compare against

ip_pool_id

Id of the existing IP Address pool

display_name

Existing IP Pool display name. This is a non updatable field

description

(Optional) description for the IP Address Pool

tags

(Optional) Opaque identifiers meaningful to the API user. Maximum 30 tags can be associated:

tags='[
    {
        "tag": "<tag-key-1>"
        "scope": "<tag-value-1>"
    },
    {
        "tag": "<tag-key-2>"
        "scope": "<tag-value-2>"
    }
]'
subnets

(Optional) The collection of one or more subnet objects in a pool. Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets.

subnets='[
    {
        "cidr": "cidr_value",
        "gateway_ip": "gateway_ip_value",
        "dns_nameservers": [
            "dns_nameserver1",
            "dns_nameserver2"
        ],
        "allocation_ranges": [
            {
                "start": "IP-Address-Range-start",
                "end": "IP-Address-Range-end"
            }
        ]
    }
]'
ip_release_delay

(Optional) Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins).

revision

Revision number of IP Pool to update

saltext.vmware.modules.nsxt_ip_pools.delete(ip_pool_id, hostname, username, password, verify_ssl=True, cert=None, cert_common_name=None)[source]#

Deletes an IP Address pool with given id

CLI Example:

salt vm_minion nsxt_ip_pools.delete hostname=nsxt-manager.local username=admin ...
hostname

The host name of NSX-T manager

username

Username to connect to NSX-T manager

password

Password to connect to NSX-T manager

ip_pool_id

Existing IP Pool id

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

cert

(Optional) Path to the SSL client certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.

cert_common_name

(Optional) By default, the hostname parameter and the common name in certificate is compared for host name verification. If the client certificate common name and hostname do not match (in case of self-signed certificates), specify the certificate common name as part of this parameter. This value is then used to compare against