opentelekomcloud.cloud.vpc_peering (0.14.2) — module

Add/Update/Delete vpc peering connection from OpenTelekomCloud

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

Authors: Polina Gubina (@polina-gubina)

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 peering from the OTC.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create a vpc peering.
- opentelekomcloud.cloud.vpc_peering:
    name: "peering1"
    local_router: "local-router"
    local_project: "959db9b6017d4a1fa1c6fd17b6820f55"
    remote_router: "peer-router"
    remote_project: "959db9b6017d4a1fa1c6fd17b6820f55"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Update vpc perring
- opentelekomcloud.cloud.vpc_peering:
    name: "peering1"
    description: "new description"
    local_router: "local-router"
    local_project: "959db9b6017d4a1fa1c6fd17b6820f55"
    remote_router: "peer-router"
    remote_project: "959db9b6017d4a1fa1c6fd17b6820f55"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Delete a load balancer(and all its related resources)
- opentelekomcloud.cloud.vpc_peering:
    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

name:
    description:
    - Name or ID of the vpc peering connection.
    - Mandatory for creating.
    - Can be updated.
    required: true
    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: Should the resource be present or absent.
    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

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:
    - Provides supplementary information about the VPC peering connection.
    type: str

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

local_router:
    description:
    - Name or ID of the local router.
    - Can not be updated.
    type: str

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

local_project:
    description:
    - Specifies the ID of the project to which a local VPC belongs.
    - Can not be updated.
    type: str

remote_router:
    description:
    - ID of the remote router.
    - Can not be updated.
    type: str

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

remote_project:
    description:
    - Specifies the ID of the project to which a peer VPC belongs.
    - Can not be updated.
    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_peering:
  contains:
    accept_vpc_info:
      contains:
        project_id:
          description: Specifies the ID of the project to which a VPC involved in
            the VPC peering connection belongs.
          sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
          type: str
        vpc_id:
          description: Specifies the ID of a VPC involved in a VPC peering connection.
          sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
          type: str
      description: Dictionary describing the local vpc.
      returned: On success when C(state=present)
      type: complex
    created_at:
      description: Specifies the time (UTC) when the VPC peering connection is created.
      returned: On success when C(state=present)
      sample: '2020-09-13T20:38:02'
      type: str
    description:
      description: Provides supplementary information about the VPC peering connection.
      returned: On success when C(state=present)
      sample: ''
      type: str
    id:
      description: Specifies the VPC peering connection ID.
      returned: On success when C(state=present)
      sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
      type: str
    name:
      description: Specifies the VPC peering connection name.
      returned: On success when C(state=present)
      sample: vpc_peering1
      type: str
    request_vpc_info:
      contains:
        project_id:
          description: Specifies the ID of the project to which a VPC involved in
            the VPC peering connection belongs.
          sample: 45007a7e-ee4f-4d13-8283-b4da2e037c69
          type: str
        vpc_id:
          description: Specifies the ID of a VPC involved in a VPC peering connection.
          sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
          type: str
      description: Dictionary describing the local vpc.
      returned: On success when C(state=present)
      type: complex
    status:
      description: Specifies the VPC peering connection status.
      returned: On success when C(state=present)
      sample: accepted
      type: str
    updated_at:
      description: Specifies the time (UTC) when the VPC peering connection is updated.
      returned: On success when C(state=present)
      sample: '2020-09-13T20:38:02'
      type: str
  description: Dictionary describing VPC peering instance.
  returned: On Success.
  type: complex