cv_facts_v3

cv_facts_v3

Collect facts from CloudVision

Module added in version 3.3.0

Synopsis

Returns list of devices, configlets, containers, images and tasks from CloudVision

Module-specific Options

The following options may be specified for this module:

parameter	type	required	default	choices	comments
facts	list	False	[‘configlets’, ‘containers’, ‘devices’, ‘images’, ‘tasks’]	configlets containers devices images tasks	List of facts to retrieve from CVP. By default, cv_facts returns facts for devices, configlets, containers, images, and tasks. Using this parameter allows user to limit scope to a subset of information.
regexp_filter	str	False	.*		Regular Expression to filter containers, configlets, devices and tasks in facts.
verbose	str	False	short	long short	Get all data from CVP or get only cv_modules data.

Examples

  tasks:
  - name: '#01 - Collect devices facts from {{inventory_hostname}}'
    arista.cvp.cv_facts_v3:

  - name: '#02 - Collect devices facts from {{inventory_hostname}}'
    arista.cvp.cv_facts_v3:
      facts:
        - configlets
    register: FACTS_DEVICES

  - name: '#03 - Collect devices facts from {{inventory_hostname}}'
    arista.cvp.cv_facts_v3:
      facts:
        - devices
        - containers
    register: FACTS_DEVICES

  - name: '#04 - Collect devices facts from {{inventory_hostname}}'
    arista.cvp.cv_facts_v3:
      facts:
        - devices
      regexp_filter: "spine1"
      verbose: long
    register: FACTS_DEVICES

  - name: '#05 - Collect images facts from {{inventory_hostname}}'
    arista.cvp.cv_facts_v3:
      facts:
        - images
    register: FACTS_DEVICES

  - name: '#06 - Collect task facts from {{inventory_hostname}}'
    arista.cvp.cv_facts_v3:
      facts:
        - tasks
      regexp_filter: 'Pending' # get facts filtered by task status - 'Failed', 'Pending', 'Completed', 'Cancelled'
      verbose: 'long'
    register: FACTS_DEVICES

  - name: '#07 - Collect task facts from {{inventory_hostname}}'
    arista.cvp.cv_facts_v3:
      facts:
        - tasks
      regexp_filter: 95 # get facts filtered by task_Id (int)
      verbose: 'long'
    register: FACTS_DEVICES

For a complete list of examples, check them out on our GitHub repository.

Module output

Example output

  msg:
    changed: false
    data:
      cvp_configlets:
        spine-2-unit-test: |-
          lldp timer 20
          username ansible privilege 15 role network-admin secret sha512 $6$DJfSedWCtJPVTpp3$HOxiovAxJlrzr4WdOnqWbT9iXwdcfXvPiN4Z5K1Z4xZfdc9G85kgwkjufLUvBp.gNe4q/fbzAugZpvHC3yc7a1
          daemon TerminAttr
             exec /usr/bin/TerminAttr -cvaddr=apiserver.cv-staging.corp.arista.io:443 -cvcompression=gzip -taillogs -cvauth=token-secure,/tmp/cv-onboarding-token -smashexcludes=ale,flexCounter,hardware,kni,pulse,strata -ingestexclude=/Sysdb/cell/1/agent,/Sysdb/cell/2/agent -disableaaa
             no shutdown
          hostname spine-2-unit-test
          ip name-server vrf default 192.0.2.40
          dns domain ire.aristanetworks.com
          interface Management1
             mtu 1380
             ip address 192.0.2.165/24
          ip route 0.0.0.0/0 192.0.2.1
          ntp server ntp.aristanetworks.com
      cvp_containers:
        CVPRACTEST:
          configlets: []
          parentContainerName: ansible-tests
          imageBundle: ""
      cvp_devices:
      - configlets:
        - leaf-2-unit-test
        - test_configlet
        - leaf-1-unit-test
        - test_device_configlet
        - cvaas-unit-test-01
        fqdn: leaf-1-unit-test.ire.aristanetworks.com
        hostname: leaf-1-unit-test
        parentContainerName: ansible-tests
        ipAddress: 192.0.2.165
        serialNumber: A2BC886CB9408A0453A3CFDD9C251999
        systemMacAddress: 50:00:00:d5:5d:c0
        imageBundle: ""
      - configlets: []
        fqdn: leaf-2-unit-test.ire.aristanetworks.com
        hostname: leaf-2-unit-test
        ipAddress: 192.0.2.166
        parentContainerName: ansible-tests
        serialNumber: 08A7E527AF711F688A6AD7D78BB5AD0A
        systemMacAddress: 50:00:00:cb:38:c2
        imageBundle: ""
      - configlets:
        - test_configlet
        fqdn: leaf-2-unit-test.ire.aristanetworks.com
        hostname: leaf-2-unit-test
        ipAddress: 192.0.2.167
        parentContainerName: ansible-tests
        serialNumber: 24666013EF2271599935B4A894F356E1
        systemMacAddress: 50:00:00:03:37:66
        imageBundle: ""
      cvp_images:
        EOS-4.25.4M.swi:
          imageBundleKeys:
            - "imagebundle_1658329041200536707"
          imageFile": ""
          imageFileName: "EOS-4.25.4M.swi"
          imageId: "EOS-4.25.4M.swi"
          imageSize: "931.9 MB"
          isHotFix: "false"
          isRebootRequire": "true"
          key: "EOS-4.25.4M.swi"
          md5: ""
          name: "EOS-4.25.4M.swi"
          sha512: "54e6874984a3a46b1371bd6c53196bbd622c922606b65d59ed3fa23e918a43d174d468ac9179146a4d1b00e7094c4755ea90c2df4ab94c562e745c14a402b491"
          swiMaxHwepoch: "2"
          swiVarient: "US"
          uploadedDateinLongFormat: 1658329024667
          user: "cvp system"
          version: "4.25.4M-22402993.4254M"
      cvp_tasks:
        93:
          ccId: ""
          ccIdV2: "g75iPnnZuWccGj1M4X2FR"
          createdBy: "arista"
          description: "Device Add: leaf2.atd.lab - To be added to Container pod1"
          workOrderDetails:
            ipAddress: "192.168.0.13",
            netElementHostName: "leaf2.atd.lab",
            netElementId: "00:1c:73:fd:a9:d8",
            serialNumber: "56789EBC8E00D7BDB3E6BBFBEB9B4FC4",
            workOrderDetailsId: "",
            workOrderId: ""
          workOrderId: "93",
          workOrderState: "ACTIVE",
          workOrderUserDefinedStatus: "Cancelled"
        total_tasks": 1
    failed: false

Author

Ansible Arista Team (@aristanetworks)

---

Last update: November 21, 2023