nttmcp.mcp.vip_ssl_certificate (1.0.9) — module

Create and Delete VIP SSL Certificate/Chain

| "added in version" 2.10.0 of nttmcp.mcp"

Authors: Ken Sinfield (@kensinfield)

preview | supported by NTT Ltd.

Install collection

Install with ansible-galaxy collection install nttmcp.mcp:==1.0.9


Add to requirements.yml

  collections:
    - name: nttmcp.mcp
      version: 1.0.9

Description

Create and Delete VIP SSL Certificate/Chain

Certificates/Chains cannot be updated or removed while still associated with an SSL Offload Profile

Adding certifications/chains can also be done a single step as part of creating an SSL Offload Profile using

vip_ssl


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: 127.0.0.1
  connection: local
  collections:
    - nttmcp.mcp
  tasks:

  - name: Import a SSL certificate
    vip_ssl_certificate:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      name: "my_cert"
      description: "my ssl cert"
      type: certificate
      path: "/path/my_cert.pem"
      key_path: "/path/my_cert_key.pem"
      state: present

  - name: Import a SSL chain
    vip_ssl_certificate:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      name: "my_chain"
      description: "my ssl chain"
      type: chain
      path: "/path/my_chain.pem"
      state: present

  - name: Delete an SSL Certificate
    vip_ssl_certificate:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      name: "my_ssl_cert"
      state: absent

Inputs

    
id:
    description:
    - The UUID of the SSL certificate/chain  (can be used for deletion)
    required: false
    type: str

auth:
    description:
    - Optional dictionary containing the authentication and API information for Cloud
      Control
    required: false
    suboptions:
      api:
        description:
        - The Cloud Control API endpoint e.g. api-na.mcp-services.net
        required: false
        type: str
      api_version:
        description:
        - The Cloud Control API version e.g. 2.11
        required: false
        type: str
      password:
        description:
        - The Cloud Control API user password
        required: false
        type: str
      username:
        description:
        - The Cloud Control API username
        required: false
        type: str
    type: dict

name:
    description:
    - The name of the SSL certificate/chain name
    required: false
    type: str

path:
    description:
    - The path to a valid SSL certificate (including certificate chain) file
    required: false
    type: str

type:
    choices:
    - certificate
    - chain
    default: certificate
    description: -The type of SSL certificate (certificate or chain)
    required: false
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The action to be performed
    type: str

region:
    default: na
    description:
    - The geographical region
    required: false
    type: str

key_path:
    description:
    - The path to the associated SSL certificate private key
    - Only required type == 'certificate' (default)
    required: false
    type: str

datacenter:
    description:
    - The datacenter name
    required: true
    type: str

description:
    description:
    - The description of the Cloud Network Domain
    required: false
    type: str

network_domain:
    description:
    - The name of a Cloud Network Domain
    required: true
    type: str

Outputs

data:
  description: The UUID of the SSL Certifcate/Chain being created or updated
  returned: when state == present
  sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
  type: str
msg:
  description: A useful message
  returned: when state == absent
  type: str