davidban77.gns3.gns3_facts (1.5.0) — module

Install collection

Install with ansible-galaxy collection install davidban77.gns3:==1.5.0

Add to requirements.yml

  collections:
    - name: davidban77.gns3
      version: 1.5.0

Description

Module that retrieves the compute(s) information of a GNS3 server

Requirements

• gns3fy

Usage examples

Scanned by Steampunk Spotter

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

# Retrieves all the  information from the computes of GNS3 server
- name: Retrieve all the facts of a GNS3 server computes
  gns3_facts:
    url: http://localhost
    get_images: all
    get_compute_ports: yes
  register: computes_info

Scanned by Steampunk Spotter

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

- debug: var=computes_info

Scanned by Steampunk Spotter

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

# Retrieves only basic facts data of the GNS3 server computes
- gns3_facts:
    url: http://localhost
  register: computes_info

Scanned by Steampunk Spotter

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

- debug: var=computes_info

Inputs

    
url:
    description:
    - URL target of the GNS3 server
    required: true
    type: str

port:
    default: 3080
    description:
    - TCP port to connect to server REST API
    type: int

user:
    description:
    - User to connect to GNS3 server
    type: str

password:
    description:
    - Password to connect to GNS3 server
    type: str

get_images:
    description:
    - If set it will also retrieve the images of the specified emulator unless
    - is set to 'all', in which case will retrieve from all emulators. For a
    - list of available emulators, visit the GNS3 API information
    type: str

get_compute_ports:
    description:
    - If set it will retrieve the console_ports and udp_ports of the compute
    type: bool

Outputs

capabilities:
  description: Object that describes what the server supports
  type: dict
compute_id:
  description: Server identifier
  type: str
compute_ports:
  description: Ports used by the compute (console and udp ports) (optional)
  type: dict
connected:
  description: Whether the controller is connected to the compute or not
  type: bool
cpu_usage_percent:
  description: CPU usage of the compute
  type: float
host:
  description: Server host
  type: str
images:
  description: Images configured on the compute depending on the emulator (optional)
  type: dict
last_error:
  description: Last error on the compute
  type: str
memory_usage_percent:
  description: RAM usage of the compute
  type: int
name:
  description: Server name
  type: str
port:
  description: Server port
  type: int
protocol:
  description: Protocol used (http, https)
  type: str
user:
  description: User for authentication
  type: str