pureport.pureport.options_info (0.0.9) — module

Install collection

Install with ansible-galaxy collection install pureport.pureport:==0.0.9

Add to requirements.yml

  collections:
    - name: pureport.pureport
      version: 0.0.9

Description

Retrieve a list of option enumerations used for creating connections

Requirements

• pureport-client

Usage examples

Scanned by Steampunk Spotter

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

- name: List options
  options_info:
    api_key: XXXXXXXXXXXXX
    api_secret: XXXXXXXXXXXXXXXXX
  register: result   # Registers result.options

Scanned by Steampunk Spotter

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

- name: List a subset of options
  options_info:
    api_key: XXXXXXXXXXXXX
    api_secret: XXXXXXXXXXXXXXXXX
    types:
      - IKEV2IKEPRF
  register: result   # Registers result.options

Inputs

    
types:
    choices:
    - IKEV1IKEEncryption
    - IKEV1IKEIntegrity
    - IKEV1IKEDHGroup
    - IKEV1ESPEncryption
    - IKEV1ESPIntegrity
    - IKEV1ESPDHGroup
    - IKEV2IKEEncryption
    - IKEV2IKEPRF
    - IKEV2IKEIntegrity
    - IKEV2IKEDHGroup
    - IKEV2ESPEncryption
    - IKEV2ESPIntegrity
    - IKEV2ESPDHGroup
    default: []
    description:
    - a list of types to filter the results
    type: list

api_key:
    description:
    - The pre-configured API Key for a Pureport Account.
    - Users should provide either the 'api_key' and 'api_secret' or the obtained 'api_access_token'.
    required: false
    type: str

api_secret:
    description:
    - The pre-configured API Secret for a Pureport Account.
    - Users should provide either the 'api_key' and 'api_secret' or the obtained 'api_access_token'.
    required: false
    type: str

api_base_url:
    description:
    - The host url for the Pureport API.
    required: false
    type: str

api_access_token:
    description:
    - The access token to use with Pureport API.  This can be obtained from
    - the `pureport_access_token_fact` module.
    - Users should provide either the 'api_key' and 'api_secret' or the obtained 'api_access_token'.
    type: str

Outputs

options:
  contains:
    key:
      description:
      - The option group type.
      returned: success
      sample: IKEV1IKEEncryption
      type: str
    value:
      contains:
        aead:
          description:
          - If the option is considered authenticated encryption with associated data
            (AEAD).
          returned: success
          sample: false
          type: bool
        default:
          description:
          - If the option is considered the default option for this group type.
          returned: success
          sample: true
          type: bool
        description:
          description:
          - The option's description.
          returned: success
          sample: 128 bit AES-CBC
          type: str
        unsafe:
          description:
          - If the option is deemed unsafe because of encryption standards.
          returned: success
          sample: false
          type: bool
        value:
          description:
          - The option's value.
          returned: success
          sample: AES_128
          type: str
      description:
      - The option group available values.
      returned: success
      type: complex
  description: a dict of Option type keys to their list of available Option values
    (dict) objects.
  returned: success
  type: complex