axiansdeveloper.ipfabric.snapshot (0.0.3) — module

Install collection

Install with ansible-galaxy collection install axiansdeveloper.ipfabric:==0.0.3

Add to requirements.yml

  collections:
    - name: axiansdeveloper.ipfabric
      version: 0.0.3

Description

Create, Update or Delete Snapshots within IPFabric

Usage examples

Scanned by Steampunk Spotter

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

- name: "Test IPFabric modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create a New Ipfabric Snapshot
      snapshot:
        ipfabric:
          host: https://ipfabric.local
          token: thisIsMyToken

    - name: Delete IPFabric Snapshot
      snapshot:
        ipfabric:
          host: https://ipfabric.local
          token: thisIsMyToken
        state: absent
        snapshot_id: 91da47aa-4843-4562-a86f-acc0012d63fd

    - name: Rediscover Device in Existing Snapshot
      snapshot:
        ipfabric:
          host: https://ipfabric.local
          token: thisIsMyToken
        snapshot_id: 91da47aa-4843-4562-a86f-acc0012d63fd
        devices:
          - ABCDE1234

    - name: Rediscover Devices in New Snapshot
      snapshot:
        ipfabric:
          host: https://ipfabric.local
          token: thisIsMyToken
        ips:
          - 192.168.1.1
          - 192.168.1.2

    - name: Load Unloaded Snapshot
      snapshot:
        ipfabric:
          host: https://ipfabric.local
          token: thisIsMyToken
      state: load
      snapshot_id: 91da47aa-4843-4562-a86f-acc0012d63fd

    - name: Unload loaded Snapshot
      snapshot:
        ipfabric:
          host: https://ipfabric.local
          token: thisIsMyToken
      state: unload
      snapshot_id: 91da47aa-4843-4562-a86f-acc0012d63fd

Inputs

    
ips:
    description:
    - List of IP addresses to discover in a new snapshot.
    - I(settings) permission is required for API token.
    required: false
    type: list

state:
    choices:
    - present
    - absent
    - load
    - unload
    description:
    - State of snapshot.
    type: str

devices:
    description:
    - List of serial numbers of devices to
    - rediscover in existing snapshot.
    required: false
    type: list

ipfabric:
    description:
    - IPFabric instance information.
    suboptions:
      host:
        description:
        - The IPFabric host name.
        - If not set, the value of the C(IPF_HOST) environment variable will be used.
        required: true
        type: str
      timeout:
        description:
        - Timeout in seconds for the connection with the IPFabric instance.
        - If not set, the value of the C(IPF_TIMEOUT) environment variable will be used.
        type: float
      token:
        description:
        - The token created within IPFabric to Authorize API access (must have snapshot
          permissions).
        - If not set, the value of the C(IPF_TOKEN) environment variable will be used.
        required: true
        type: str
      validate_certs:
        description:
        - IF C(no), SSL certificates will not be calidated. This should only be used on
          personally controlled sites using self-signed certificates.
        - If not set, the value of the C(IPF_CERTS) environment variable will be used.
        required: false
        type: raw
    type: dict

snapshot_id:
    description: Snapshot ID
    required: false
    type: str

Outputs

data:
  description: Data returned from the module.
  returned: always
  type: list
msg:
  description: Message indicating failure or info about what has happened.
  returned: always
  type: str