opentelekomcloud.cloud.nat_dnat_rule (0.14.2) — module

Manage NAT DNAT rules

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

Authors: Sebastian Gode (@SebastianGode)

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 DNAT rules


Requirements

Inputs

    
id:
    description:
    - ID of the DNAT rule
    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

port:
    description:
    - Specifies the port ID of an ECS or a BMS. This parameter and private_ip are alternative
    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

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

protocol:
    choices:
    - tcp
    - udp
    - any
    default: tcp
    description:
    - Specifies the protocol type. Currently, TCP, UDP, and ANY are supported.
    - Mandatory for DNAT rule creation
    type: str

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

private_ip:
    description:
    - Specifies the private IP address, for example, the IP address of a Direct Connect
      connection. This parameter and port are alternative
    type: str

project_id:
    description:
    - Specifies the project ID
    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:
    - ID or Name of the floating IP
    - Mandatory for DNAT rule creation
    type: str

nat_gateway:
    description:
    - ID or Name of the NAT gateway
    - Mandatory for DNAT rule creation
    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:
    - DNAT rule 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

external_service_port:
    description:
    - Specifies the port for providing external services.
    - Mandatory for DNAT rule creation
    type: str

internal_service_port:
    description:
    - Specifies the port used by ECSs or BMSs to provide services for external systems
    - Mandatory for DNAT rule creation
    type: str

Outputs

dnat_rule:
  contains:
    admin_state_up:
      description: Specifies whether the rule is active or down.
      sample: true
      type: bool
    created_at:
      description: Creation time of the DNAT rule
      sample: yyyy-mm-dd hh:mm:ss
      type: str
    external_service_port:
      description: Specifies the port for providing external services.
      sample: 80
      type: str
    floating_ip:
      description: IP / ID of the floating IP Address assigned to the rule.
      sample: 123.12.1.12
      type: str
    id:
      description: ID of the DNAT rule
      sample: 5acab424-69fb-4408-93d1-b2801b306827
      type: str
    internal_service_port:
      description: Specifies the port used by ECSs or BMSs to provide services for
        external systems
      sample: 80
      type: str
    nat_gateway_id:
      description: ID or name of the assigned Nat gateway.
      sample: 2aa32feb-f0b7-4dcc-a7b4-e0233686702b
      type: str
    port:
      description: Specifies the port ID of an ECS or a BMS. This parameter and private_ip
        are alternative
      sample: 736abea5-aaf8-40b9-bf17-cc081a785d67
      type: str
    private_ip:
      description: Specifies the private IP address, e.g. the IP address of a Direct
        Connect connection. This parameter and port are alternative
      sample: 192.168.2.1
      type: str
    protocol:
      description: Used protocol
      sample: tcp
      type: str
    status:
      description: Specifies the status of the NAT gateway.
      sample: ACTIVE
      type: str
  description: List of dictionaries describing DNAT rules.
  returned: On Success.
  type: complex