pureport.pureport.pureport_location_facts (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 locations

Requirements

• pureport-client

Usage examples

Scanned by Steampunk Spotter

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

- name: List locations
  locations_info:
    api_key: XXXXXXXXXXXXX
    api_secret: XXXXXXXXXXXXXXXXX
  register: result   # Registers result.locations

Scanned by Steampunk Spotter

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

- name: Display all locations hrefs using a json_query filter
  debug:
    var: item
  loop: "{{ result.locations | 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

locations:
  contains:
    geo_coordinates:
      contains:
        latitude:
          description:
          - The location's latitude.
          returned: success
          sample: 47.6062
          type: double
        longitude:
          description:
          - The location's longitude.
          returned: success
          sample: -122.3321
          type: double
      description:
      - The location's geo-coordinates.
      returned: success
      type: complex
    href:
      description:
      - The location href, a path to resource on the server.
      returned: success
      sample: /locations/us-sea
      type: str
    id:
      description:
      - The location id.
      returned: success
      sample: us-sea
      type: str
    location_links:
      contains:
        href:
          description:
          - The other location href.
          returned: success
          sample: /locations/us-ral
          type: str
        id:
          description:
          - The other location id.
          returned: success
          sample: us-ral
          type: str
        title:
          description:
          - The other location name.
          returned: success
          sample: Raleigh, NC
          type: str
      description:
      - A list of other Location Link objects that this Location has a Pureport backbone
        connection to.
      returned: success
      type: complex
    name:
      description:
      - The location name.
      returned: success
      sample: Seattle, WA
      type: str
  description: A list of Location (dict) objects.
  returned: success
  type: complex