opentelekomcloud.cloud.nat_gateway (0.14.2) — module

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 gateway instances

Requirements

• openstacksdk
• openstacksdk >= 0.36.0
• otcextensions
• python >= 3.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Get configs versions.
- nat_gateway:
    internal_network_id: 1234f0c7-82e3-478d-8433-dc5984859e3b
    name: my_gateway
    router: 1234f70c-6d1d-471e-a911-6924b7ec6ea9
    state: present

Inputs

    
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

name:
    description:
    - Name of the NAT gateway.
    required: true
    type: str

spec:
    choices:
    - '1'
    - '2'
    - '3'
    - '4'
    default: '1'
    description:
    - Specifies the type of the NAT gateway. 1 (small 10.000 connections), 2 (medium 50.000
      connections), 3 (large 200.000 connections), 4 (extra-large 1.000.000 connections)
    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

router:
    description:
    - ID or name of the router where the NAT gateway is attached.
    - Mandatory for creating gateway instance.
    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

project:
    description:
    - ID or name of the project where the NAT gateway is attached to.
    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

description:
    description:
    - Description of the NAT gateway
    type: str

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

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

admin_state_up:
    description:
    - NAT gateway state.
    type: bool

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

internal_network:
    description:
    - Name or ID of the network where the NAT gateway is attached to.
    - Mandatory for creating gateway instance.
    type: str

Outputs

gateway:
  contains:
    admin_state_up:
      description: Specifies whether gateway is up or down.
      sample: true
      type: bool
    created_at:
      description: Creation time of the NAT gateway
      sample: yyyy-mm-dd hh:mm:ss
      type: str
    description:
      description: Description of the NAT gateway
      sample: My Gateway
      type: str
    id:
      description: ID of the NAT gateway
      sample: my-gateway
      type: str
    internal_network_id:
      description: Network ID where the NAT gateway is attached to.
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a123
      type: str
    name:
      description: Name of the NAT gateway.
      sample: my-gateway
      type: str
    project_id:
      description: Project ID where the NAT gateway is located in.
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a567
      type: str
    router_id:
      description: VPC / Router ID where the NAT gateway is attached to.
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a123
      type: str
    spec:
      description: Specifies the type of the NAT gateway.
      sample: '1'
      type: str
    status:
      description: Specifies the status of the NAT gateway.
      sample: ACTIVE
      type: str
  description: List of dictionaries describing NAT gateways.
  returned: On Success.
  type: complex