pureport.pureport.cloud_services_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 cloud services

Requirements

• pureport-client

Usage examples

Scanned by Steampunk Spotter

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

- name: List cloud services
  cloud_services_info:
    api_key: XXXXXXXXXXXXX
    api_secret: XXXXXXXXXXXXXXXXX
  register: result   # Registers result.cloud_services

Scanned by Steampunk Spotter

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

- name: Display all cloud service hrefs using a json_query filter
  debug:
    var: item
  loop: "{{ result.cloud_services | json_query('[*].href') }}"

Inputs

    
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

cloud_services:
  contains:
    cloud_region:
      contains:
        href:
          description:
          - The cloud region href.
          returned: success
          sample: /cloudRegions/aws-us-west-1
          type: str
        id:
          description:
          - The cloud region id.
          returned: success
          sample: aws-us-west-1
          type: str
        title:
          description:
          - The cloud region display name.
          returned: success
          sample: US West (N. California)
          type: str
      description:
      - The Cloud Region Link object which this service corresponds to.
      type: complex
    href:
      description:
      - The cloud service href, a path to resource on the server.
      returned: success
      sample: /cloudServices/aws-s3-us-west-1
      type: str
    id:
      description:
      - The cloud service id.
      returned: success
      sample: aws-s3-us-west-1
      type: str
    ipv4_prefix_count:
      description:
      - The number of ipv4 prefixes this service uses.
      returned: success
      sample: 3
      type: int
    ipv6_prefix_count:
      description:
      - The number of ipv6 prefixes this service uses.
      returned: success
      sample: 4
      type: int
    name:
      description:
      - A name for this cloud service.
      returned: success
      sample: AWS S3 us-west-1
      type: str
    provider:
      description:
      - The cloud service provider.
      returned: success
      sample: AWS
      type: str
    service:
      description:
      - The service name for the provider.
      returned: success
      sample: S3
      type: str
  description: A list of CloudService (dict) objects.
  returned: success
  type: complex