opentelekomcloud.cloud.nat_dnat_rule_info (0.14.2) — module

Get DNAT rule details

| "added in version" 0.0.4 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

Get DNAT Rule Details.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get configs versions.
- nat_dnat_rule_info:
    floating_ip: "123.1.2.3"
  register: dn
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- nat_dnat_rule_info:
    rule: "2f561c37-277e-412a-8f76-0d430b596de5"
  register: dn
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- nat_dnat_rule_info:
    admin_state_up: "true"
    status: "ACTIVE"
  register: dn

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

port:
    description:
    - Name or ID of a network port of an ECS or BMS
    type: str

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

status:
    description:
    - rule enabled or disabled
    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

gateway:
    description:
    - Name or ID of the NAT gateway
    type: str

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

protocol:
    description:
    - Specifies the protocol type. Currently TCP(6), UDP(17) and ANY(0)
    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

created_at:
    description:
    - Creation time of the rule
    type: str

private_ip:
    description:
    - Specifies the IP adress of a Direct Connect connection
    type: str

project_id:
    description:
    - Filters SNAT rules for 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:
    - IP or ID of floating IP address.
    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 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.
    type: int

internal_service_port:
    description:
    - Specifies port used by ECS/BMS to provide services to external systems
    type: int

Outputs

dnat_rules:
  contains:
    admin_state_up:
      description: NAT rule state
      sample: true
      type: bool
    created_at:
      description: Creation time
      sample: yyyy-mm-dd hh:mm:ss
      type: str
    external_service_port:
      description: Specifies the port for providing external services
      sample: 8080
      type: int
    floating_ip:
      description: IP or ID of Floating IP address.
      sample: 123.1.2.3
      type: str
    gateway:
      description: Name or ID of the NAT gateway
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a123
      type: str
    id:
      description: ID of the DNAT rule
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a123
      type: str
    internal_service_port:
      description: Specifies the port used by ECS/BMS
      sample: 8081
      type: int
    port:
      description: Name or ID of a network port of an ECS or BMS
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a123
      type: str
    private_ip:
      description: Specifies the private IP
      sample: 10.1.2.3
      type: str
    project_id:
      description: ID of the Project where the DNAT rule is located in
      sample: 16d53a84a13b49529d2e2c3646612345
      type: str
    protocol:
      description: Specifies the protocol type. Currently TCP(6), UDP(17) and ANY(0)
      sample: '6'
      type: str
    source_type:
      description: 0 Either network id or cidr can be specified in VPC ... 1 only
        cidr can be specified over Direct Connect
      sample: '0'
      type: str
    status:
      description: NAT rule status
      sample: ACTIVE
      type: str
  description: List of DNAT rules.
  returned: On Success.
  type: complex