saltext.vmware.states.nsxt_ip_blocks#

Salt State file to create/update/delete an IP Address Block

Example:

create_ip_block:
  nsxt_ip_blocks.present:
    - name: Create IP Block
      hostname: {{ pillar['nsxt_manager_hostname'] }}
      username: {{ pillar['nsxt_manager_username'] }}
      password: {{ pillar['nsxt_manager_password'] }}
      cert: {{ pillar['nsxt_manager_certificate'] }}
      verify_ssl: <False/True>
      display_name: <ip block name>
      description: <ip block description>
      tags:
        - tag: <tag-key-1>
          scope: <tag-value-1>
        - tag: <tag-key-2>
          scope: <tag-value-2>
      cidr: <cidr>

saltext.vmware.states.nsxt_ip_blocks.__virtual__()[source]#: Only load if the nsxt_ip_blocks module is available in __salt__

saltext.vmware.states.nsxt_ip_blocks.present(name, display_name, cidr, hostname, username, password, cert=None, verify_ssl=True, cert_common_name=None, description=None, tags=None)[source]#

Creates/Updates(if present with the same name) an IP Address Block

create_ip_block:
  nsxt_ip_blocks.present:
    - name: Create IP Block
      hostname: {{ pillar['nsxt_manager_hostname'] }}
      username: {{ pillar['nsxt_manager_username'] }}
      password: {{ pillar['nsxt_manager_password'] }}
      cert: {{ pillar['nsxt_manager_certificate'] }}
      verify_ssl: <False/True>
      display_name: <ip block name>
      description: <ip block description>
      tags:
        - tag: <tag-key-1>
          scope: <tag-value-1>
        - tag: <tag-key-2>
          scope: <tag-value-2>
      cidr: <cidr>

name

The Operation to perform

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 Block will be created. In case of update the provided display_name should be unique else the method will raise an error

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

saltext.vmware.states.nsxt_ip_blocks.absent(name, display_name, hostname, username, password, cert=None, verify_ssl=True, cert_common_name=None)[source]#

Deletes an IP Address Block of provided name (if present)

delete_ip_block:
  nsxt_ip_blocks.absent:
    - name: Delete IP Block
      hostname: <hostname>
      username: <username>
      password: <password>
      cert: <certificate>
      verify_ssl: <False/True>
      display_name: <ip block name>

name: The Operation to perform
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: Display name of IP Address Block to delete