nttmcp.mcp.vip_ssl (1.0.9) — module

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, Update and Delete VIP SSL Offload Profile Configuration

Requirements

• requests
• configparser
• pyOpenSSL
• netaddr

Usage examples

Scanned by Steampunk Spotter

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

- hosts: 127.0.0.1
  connection: local
  collections:
    - nttmcp.mcp
  tasks:

  - name: Create an SSL Offload Profile
    vip_ssl:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      name: "my_ssl_profile"
      description: "my ssl profile"
      certificate:
        name: "my_cert"
        description: "My Certificate"
        path: "/path/my_cert.pem"
        key_path: "/path/my_cert_key.pem"
      chain:
        name: "my_cert_chain"
        description: "My Certificate Chain"
        path: "/path/my_cert_chain.pem"
      ciphers: "DHE+AES:DHE+AES-GCM:RSA+AES:RSA+3DES:RSA+AES-GCM"
      state: present

  - name: Update an SLL Offload Profile - Update the name and change the certificate
    vip_ssl:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      name: "my_ssl_profile"
      new_name: "my_ssl_profile_2"
      description: "my 2nd ssl profile"
      certificate:
        name: "my_cert_2"
        description: "My 2nd Certificate"
        path: "/path/my_cert_2.pem"
        key_path: "/path/my_cert_key_2.pem"
      chain:
        name: "my_cert_chain"
        description: "My Certificate Chain"
        path: "/path/my_cert_chain.pem"
      ciphers: "DHE+AES:DHE+AES-GCM:RSA+AES:RSA+3DES:RSA+AES-GCM"
      state: present

  - name: Delete an SSL Offload Profile - If this profile is the last associated profile with the cert and chain they will also be removed
    vip_ssl:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      name: "my_ssl_profile"
      state: absent

Inputs

    
id:
    description:
    - The UUID of the SSL Offload profile (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 Offload Profile
    required: false
    type: str

chain:
    description:
    - The certificate chain to use for the this SSL Offload Profile
    required: false
    suboptions:
      name:
        description:
        - The name of the SSL certificate chain to upload/use
        required: true
        type: str
      path:
        description:
        - The path to a valid SSL certificate file
        required: true
        type: str
    type: dict

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

ciphers:
    description:
    - Ciphers needs to be a valid F5 Cipher string https://support.f5.com/csp/article/K13171
    - Example "DHE+AES:DHE+AES-GCM:RSA+AES:RSA+3DES:RSA+AES-GCM:DHE+3DES"
    required: false
    type: str

new_name:
    description:
    - The new name of the SSL Offload Profile. Used when modifying the name of an existing
      SSL Offload Profile.
    required: false
    type: str

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

certificate:
    description:
    - The certificate to use for the this SSL Offload Profile
    required: false
    suboptions:
      key_path:
        description:
        - The path to the associated SSL certificate private key
        type: str
      name:
        description:
        - The name of the SSL certificate to upload/use
        required: true
        type: str
      path:
        description:
        - The path to a valid SSL certificate file
        required: true
        type: str
    type: dict

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 OffLoad profile 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