opentelekomcloud.cloud.vpc_route (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

Add or Remove VPC route from the OTC VPC Route service.

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.

# Create a vpc route.
- opentelekomcloud.cloud.vpc_route:
    destination: "6ysa5bac-0925-6d5b-add8-cb6667b8"
    nexthop: "67sa5bac-0925-4p5b-add8-cb6667b8"
    router_id: "89sa5bac-0925-9h7b-add8-cb6667b8"
  register: vpc_route

Scanned by Steampunk Spotter

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

# Delete vpc route
- opentelekomcloud.cloud.vpc_route:
    name: "peering2"
    state: absent

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

type:
    default: peering
    description: Type of a route.
    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: ID of the VPC ID requesting for creating a route.
    type: str

router:
    description: ID or name of the router requesting for creating a route.
    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

nexthop:
    description: The next hop. If type is peering, it is the VPC peering connection name
      or id.
    type: str

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

route_id:
    description: Route ID.
    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

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

destination:
    description: Route destination address (CIDR).
    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

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

vpc_route:
  contains:
    destination:
      description: Destination address in the CIDR notation format.
      returned: On success when C(state=present)
      sample: 192.168.200.0/24
      type: str
    id:
      description: Route ID.
      returned: On success when C(state=present)
      sample: 4dae5bac-0925-4d5b-add8-cb6667b8
      type: str
    nexthop:
      description: The next hop. If type is peering, it is the VPC peering connection
        ID
      returned: On success when C(state=present)
      sample: 7375f1cd-6fe1-4d47-8888-c5c5a64298d8
      type: str
    project_id:
      description: Project id.
      returned: On success when C(state=present)
      sample: 6ysa5bac-0925-4d5b-add8-cb6667b8
      type: str
    router_id:
      description: The router of the route.
      returned: On success when C(state=present)
      sample: 4dae5bac-0725-2d5b-add8-cb6667b8
      type: str
    type:
      description: The route type.
      returned: On success when C(state=present)
      sample: peering
      type: str
  description: Specifies the vpc route.
  returned: On Success.
  type: complex