opentelekomcloud.cloud.nat_snat_rule (0.14.2) — module

Manage NAT SNAT rule instances

| "added in version" 0.0.1 of opentelekomcloud.cloud"

Authors: Tino Schreiber (@tischrei)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Manage NAT SNAT rule instances


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create snat_rule with cidr
- nat_snat_rule:
    cloud: otc
    nat_gateway: 0035136a-9b29-4232-b456-1059ca11a123
    floating_ip: '80.158.47.5'
    cidr: '192.168.0.0/32'
    state: present
  register: snat
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create SNAT rule with network
- nat_snat_rule:
    cloud: otc
    nat_gateway: 0035136a-9b29-4232-b456-1059ca11a123
    floating_ip: '80.158.47.5'
    network: c6b2dbc9-ca80-4b49-bbbb-85ea9b96f123
    state: present
  register: snat

Inputs

    
id:
    description:
    - ID of the NAT SNAT rule
    - Mandatory for SNAT rule deletion
    type: str

auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(os_project_domain_name)) if the cloud supports them. For other plugins, this
      param will need to contain whatever parameters that auth plugin requires. This parameter
      is not needed if a named cloud is provided or OpenStack OS_* environment variables
      are present.
    type: dict

cidr:
    description:
    - Specifies a subset of the VPC subnet CIDR block or
    - a CIDR block of Direct Connect connection.
    type: str

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

state:
    choices:
    - present
    - absent
    default: present
    description: Instance state
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

network:
    description:
    - ID or Name of the network for the SNAT rule.
    - Mandatory for SNAT rule creation
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

auth_type:
    description:
    - Name of the auth plugin to use. If the cloud uses something other than password
      authentication, the name of the plugin should be indicated here and the contents
      of the I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

api_timeout:
    description:
    - How long should the socket layer wait before timing out for API calls. If this is
      omitted, nothing will be passed to the requests library.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

floating_ip:
    description:
    - Address or ID of the floating IP where the SNAT rule is attached to.
    - Mandatory for SNAT rule creation
    type: str

nat_gateway:
    description:
    - Name or ID of the NAT gateway
    - Mandatory for SNAT rule creation
    type: str

region_name:
    description:
    - Name of the region.
    type: str

source_type:
    choices:
    - 0
    - 1
    default: 0
    description:
    - 0 Either network_id or cidr can be specified in VPC
    - 1 only cidr can be specified over a Direct Connect connection.
    type: int

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

Outputs

snat_rule:
  contains:
    admin_state_up:
      description: Specifies whether gateway is up or down.
      sample: true
      type: bool
    cidr:
      description:
      - Specifies a subset of the VPC subnet CIDR block or
      - a CIDR block of Direct Connect connection.
      sample: 192.168.1.10/32
      type: str
    created_at:
      description: Creation time of the NAT SNAT rule
      sample: yyyy-mm-dd hh:mm:ss
      type: str
    floating_ip_address:
      description: Address of the floating IP
      sample: e1029c97-639e-4481-9254-f30c5632b123"
      type: str
    floating_ip_id:
      description: ID of the floating IP address
      sample: e1029c97-639e-4481-9254-f30c5632b123
      type: str
    id:
      description: ID of the NAT SNAT rule
      sample: 3fea684b-50f1-4613-967a-a7bed5e59123
      type: str
    nat_gateway_id:
      description: ID of the attached NAT gateway
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a123
      type: str
    network_id:
      description:
      - Network ID of the subnet where the NAT SNAT rule
      - points to.
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a567
      type: str
    source_type:
      description:
      - 0 Either network_id or cidr can be specified in VPC
      - 1 only cidr can be specified over a Direct Connect connection.
      sample: 0
      type: int
    status:
      description: Specifies the status of the NAT gateway.
      sample: ACTIVE
      type: str
    tenant_id:
      description: Project ID where the NAT SNAT rule is located in.
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a567
      type: str
  description: Dictionary describing the SNAT rule.
  returned: On Success.
  type: complex