qrkourier.netfoundry.netfoundry_info (1.2.0) — module

Install collection

Install with ansible-galaxy collection install qrkourier.netfoundry:==1.2.0

Add to requirements.yml

  collections:
    - name: qrkourier.netfoundry
      version: 1.2.0

Description

Discover NetFoundry Network resources with an API account

Requirements

• netfoundry

Usage examples

Scanned by Steampunk Spotter

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

# Pass in a message
- name: discover resources in the Network
  qrkourier.netfoundry.netfoundry_info:
    networkName: BibbidiBobbidiBoo
    credentials: credentials.json
  register: network_info

Inputs

    
credentials:
    description: Path to API account credentials JSON file relative to playbook directory.
    required: true
    type: path

networkName:
    description: The name of the Network to describe.
    required: true
    type: str

networkGroupId:
    description: Network Group UUID. Only necessary if there is more than one, which is
      unusual.
    required: false
    type: str

Outputs

message:
  description: The output message that the test module generates.
  returned: always
  sample: goodbye
  type: str
netfoundry_info:
  description: The dictionary containing information about your Network.
  returned: always
  sample:
    answer: 42
    foo: bar
  type: dict
original_message:
  description: The original name param that was passed in.
  returned: always
  sample: BibbidiBobbidiBoo
  type: str