opentelekomcloud.cloud.lb_certificate (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 ELB certificates.

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 lb certificate.
- opentelekomcloud.cloud.lb_certificate:
    state: present
    name: certificate-test
    content: "{{ dummy-cert }}"
    type: client
  register: lb_cert

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: Certificate name or ID.
    required: true
    type: str

type:
    choices:
    - server
    - client
    default: server
    description: Specifies the certificate type.
    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: Certificate state
    type: str

domain:
    description: Specifies the domain name associated with the server certificate.
    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

content:
    description: Certificate content or path to file with content. Required for creation.
    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 certificate.
    type: str

private_key:
    description: Private key for the certificate or path to file with key. Required for
      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: Specifies the administrative status of the certificate.
    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

Outputs

elb_certificate:
  contains:
    admin_state_up:
      description: Administrative status of the certificate.
      type: bool
    certificate:
      description: Public key of the server certificate or CA certificate used to
        authenticate the client.
      type: str
    create_time:
      description: Certificate creation time
      sample: 1630488473000
      type: int
    description:
      description: Supplementary information about the certificate.
      type: str
    domain:
      description: Domain name associated with the server certificate.
      type: str
    expire_time:
      description: Expiration timestamp
      sample: 1630488473000
      type: int
    id:
      description: Unique UUID.
      sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
      type: str
    name:
      description: Name of the certificate.
      sample: test
      type: str
    private_key:
      description: Private key of the server certificate in PEM format.
      type: str
    type:
      description: Certificate type.
      type: str
    update_time:
      description: Certificate update time
      sample: 1630488473000
      type: int
  description: Certificate data.
  returned: On Success.
  type: complex