pureport.pureport.network (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

Create, update or delete a network

Requirements

• pureport-client

Inputs

    
id:
    description:
    - The id of the existing network
    required: false
    type: str

name:
    description:
    - The name of the network
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The state of the object, where 'present' indicates it should should
    - exist and 'absent' indicates it should not exist.
    required: false
    type: str

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

description:
    description:
    - A description for the network
    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

resolve_existing:
    default: true
    description:
    - If an id was not provided, attempt to resolve the existing item using the name.
    required: false
    type: bool

Outputs

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