saltext.vmware.modules.nsxt_ip_blocks#

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

saltext.vmware.modules.nsxt_ip_blocks.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 IP Address blocks present in the NSX-T Manager for given query params

CLI Example:

salt vm_minion nsxt_ip_blocks.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_blocks.get_by_display_name(hostname, username, password, display_name, verify_ssl=True, cert=None, cert_common_name=None)[source]#

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

CLI Example:

salt vm_minion nsxt_ip_blocks.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 block 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_blocks.create(cidr, hostname, username, password, verify_ssl=True, cert=None, cert_common_name=None, display_name=None, description=None, tags=None)[source]#

Creates an IP Address block with given specifications

CLI Example:

salt vm_minion nsxt_ip_blocks.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

cidr

Represents network address and the prefix length which will be associated with a layer-2 broadcast domain

display_name

(Optional) The name using which IP Address Block will be created. If not provided then block id will be used as display name

description

(Optional) description for the IP Address Block

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>"
    }
]'
saltext.vmware.modules.nsxt_ip_blocks.update(ip_block_id, cidr, display_name, revision, hostname, username, password, verify_ssl=True, cert=None, cert_common_name=None, description=None, tags=None)[source]#

Updates an IP Address block 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_blocks.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_block_id

Id of the existing IP Address block

display_name

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

description

(Optional) description for the IP Address Block

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>"
    }
]'
cidr

Represents network address and the prefix length which will be associated with a layer-2 broadcast domain

revision

Revision number of IP block to update

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

Deletes an IP Address block with given id

CLI Example:

salt vm_minion nsxt_ip_blocks.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_block_id

Existing IP Block 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