pureport.pureport.pureport_facility_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 facilities

Requirements

• pureport-client

Usage examples

Scanned by Steampunk Spotter

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

- name: List facilities
  facilities_info:
    api_key: XXXXXXXXXXXXX
    api_secret: XXXXXXXXXXXXXXXXX
  register: result   # Registers result.facilities

Scanned by Steampunk Spotter

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

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

facilities:
  contains:
    href:
      description:
      - The facility href, a path to resource on the server.
      returned: success
      sample: /facilities/us-colo-atl
      type: str
    id:
      description:
      - The facility id.
      returned: success
      sample: us-colo-atl
      type: str
    name:
      description:
      - The facility name.
      returned: success
      sample: Colo Atl
      type: str
    physical_address:
      contains:
        city:
          description:
          - The city
          required: false
          type: str
        country:
          description:
          - The country
          required: false
          type: str
        geo_coordinates:
          contains:
            latitude:
              description:
              - The latitude
              required: false
              type: double
            longitude:
              description:
              - The longitude
              required: false
              type: double
          description:
          - A dict representing the geo coordinates of a facility
          required: false
          type: complex
        postal_code:
          description:
          - The postal code
          required: false
          type: str
        state:
          description:
          - The state
          required: false
          type: str
        street:
          description:
          - The street address
          required: false
          type: str
      description:
      - Information about the physical address of the facility.
      returned: success
      type: complex
    state:
      description:
      - The state of the facility
      returned: success
      sample: ACTIVE
      type: str
    vendor:
      description:
      - The facility vendor
      returned: success
      sample: JTC
      type: str
  description: A list of Facility (dict) objects.
  returned: success
  type: complex