pureport.pureport.supported_ports_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 supported ports 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 supported ports
  supported_ports_info:
    api_key: XXXXXXXXXXXXX
    api_secret: XXXXXXXXXXXXXXXXX
    account_href: /accounts/ac-XXXXXXXXXXXXXXXXXXXXXX
    facility_href: /facilities/us-colo-atl
  register: result   # Registers result.supported_ports

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

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

supported_ports:
  contains:
    availability_domains:
      description:
      - The list of availability domains for the specified port.
      returned: success
      sample:
      - PRIMARY
      - SECONDARY
      type: str
    billing_plans:
      contains:
        amount:
          description:
          - The amount in cents for this plan.
          returned: success
          sample: 15
          type: int
        billing_interval:
          description:
          - The time period billing is accumulated and sent to the user for payment.
          returned: success
          sample: MONTH
          type: str
        id:
          description:
          - The billing plan id.
          returned: success
          sample: plan_EJ36MVNfXZ7C3x
          type: str
        setup_amount:
          description:
          - The amount in cents for this initial setup fee
          returned: success
          sample: 1809
          type: int
        term:
          description:
          - The frequency at which the 'amount' is accumulated with this connection
            plan.
          returned: success
          sample: HOURLY
          type: str
      description:
      - A list of supported billing plans for this supported port.
      returned: success
      type: complex
    facility:
      contains:
        href:
          description:
          - The facility href.
          returned: success
          sample: /facilities/us-colo-atl
          type: str
        id:
          description:
          - The facility id.
          returned: success
          sample: us-colo-atl
          type: str
        title:
          description:
          - The facility name.
          returned: success
          sample: Colo ATL
          type: str
      description:
      - The Facility Link object of the supported port.
      returned: success
      type: complex
    media_types:
      description:
      - The list of available media types for the specified port.
      returned: success
      sample:
      - LX
      - LR4
      type: list
    provider:
      description:
      - The supported port provider.
      returned: success
      sample: PACKET_FABRIC
      type: str
    speed:
      description:
      - The speed of the supported port.
      returned: success
      sample: 1000
      type: int
  description: A list of SupportedPort (dict) objects.
  returned: success
  type: complex