nttmcp.mcp.vip_ssl_info (1.0.9) — module

List/Get VIP SSL Configuration

| "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

List/Get VIP SSL Configuration

It is quicker to use the option "id" to locate the SSL configuration if the UUID is known rather than search by name


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: List all SSL certificates for a Network Domain
    vip_ssl_info:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"

  - name: List all SSL Chains for a Network Domain
    vip_ssl_info:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      type: chain

  - name: Get a specific SSL Profile by ID
    vip_ssl_info:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      type: profile
      id: bbc866b0-2f13-44b4-8339-49890f10dc3c

  - name: Get a specific SSL Profile by name
    vip_ssl_info:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      type: profile
      name: "My_SSL_Profile"

Inputs

    
id:
    default: null
    description:
    - The UUID of the node
    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:
    default: null
    description:
    - The name of the node
    required: false
    type: str

type:
    choices:
    - certificate
    - chain
    - profile
    default: certificate
    description:
    - The type of SSL entity to search for
    required: false
    type: str

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

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

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

Outputs

data:
  contains:
    ssl_certificate:
      contains:
        createTime:
          description: The creation date of the SSL certificate
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        datacenterId:
          description: The MCP ID
          sample: NA9
          type: str
        description:
          description: SSL certificate description
          sample: My Cert
          type: str
        expiryTime:
          description: The expiry date of the SSL certificate
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        id:
          description: The UUID of the SSL certificate
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        name:
          description: The SSL certificate display name
          sample: my_cert
          type: str
        networkDomainId:
          description: The UUID of the Cloud Network Domain
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
      description: List of SSL Certificates
      returned: when type == 'certificate' (default)
      type: complex
    ssl_chain:
      contains:
        createTime:
          description: The creation date of the SSL chain
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        datacenterId:
          description: The MCP ID
          sample: NA9
          type: str
        description:
          description: SSL chain description
          sample: My Cert
          type: str
        expiryTime:
          description: The expiry date of the SSL chain
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        id:
          description: The UUID of the SSL chain
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        name:
          description: The SSL chain display name
          sample: my_chain
          type: str
        networkDomainId:
          description: The UUID of the Cloud Network Domain
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
      description: List of SSL Chain
      returned: when type == 'chain' (default)
      type: complex
    ssl_profile:
      contains:
        ciphers:
          description: Cipher needs to be a valid F5 Cipher string - https://support.f5.com/csp/article/K13171
          sample: DHE+AES:DHE+AES-GCM:RSA+AES:RSA+3DES:RSA+AES-GCM:DHE+3DES
          type: str
        createTime:
          description: The creation date of the SSL chain
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        datacenterId:
          description: The MCP ID
          sample: NA9
          type: str
        id:
          description: The UUID of the SSL Offload Profile
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        name:
          description: The name of the SSL Offload Profile
          sample: my_ssl_profile
          type: str
        networkDomainId:
          description: The UUID of the Cloud Network Domain
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        sslCertificateChain:
          contains:
            expiryTime:
              description: The expiry date of the SSL chain
              sample: '2019-01-14T11:12:31.000Z'
              type: str
            id:
              description: The UUID of the SSL chain
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            name:
              description: The SSL chain display name
              sample: my_chain
              type: str
          description: The optional SSL certificate chain
          type: complex
        sslDomainCertificate:
          contains:
            expiryTime:
              description: The expiry date of the SSL certificate
              sample: '2019-01-14T11:12:31.000Z'
              type: str
            id:
              description: The UUID of the SSL certificate
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            name:
              description: The SSL certificate display name
              sample: my_cert
              type: str
          description: List of SSL Certificates
          type: complex
        state:
          description: The operational state of the SSL Offload Profile
          sample: NORMAL
          type: str
      description: SSL Profile Object
      returned: when type == 'profile' (default)
      type: complex
  description: Dictionary of the vlan
  returned: success
  type: complex