pureport.pureport.networks_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 networks for an account

Requirements

• pureport-client

Usage examples

Scanned by Steampunk Spotter

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

- name: List networks for an account
  networks_info:
    api_key: XXXXXXXXXXXXX
    api_secret: XXXXXXXXXXXXXXXXX
    account_href: /accounts/ac-XXXXXXXXXXXXXXXXXXXXXX
  register: result   # Registers result.networks

Scanned by Steampunk Spotter

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

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

account_href:
    description:
    - The Pureport Account object.
    - This should be the full 'href' path to the Account ReST object (e.g /accounts/abc).
    required: true
    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

networks:
  contains:
    description:
      description:
      - The description of the network.
      returned: success
      sample: My network description
      type: str
    href:
      description:
      - The network href, a path to resource on the server.
      returned: success
      sample: /networks/network-rfqj4qc9fO8hDOczEB7Z_Q
      type: str
    id:
      description:
      - The network id.
      returned: success
      sample: network-rfqj4qc9fO8hDOczEB7Z_Q
      type: str
    name:
      description:
      - The name of the network.
      returned: success
      sample: My Network Name
      type: str
  description: A list of Network (dict) objects.
  returned: success
  type: complex