doc: run pre-commit

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
     hooks:
       - name: Check and insert license on Python files
         id: insert-license
-        exclude: ansible_collections/arista/cvp/(plugins|tests/unit(/module_utils|/modules|))/__init__.py
+        exclude: .*\__init__.py$
         files: .*\.py$
         args:
           - --license-filepath

README.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Ansible Modules for Arista CloudVision Platform
 
 ![Arista CVP](https://img.shields.io/badge/Arista-CVP%20Automation-blue) ![[collection version](https://github.com/aristanetworks/ansible-cvp/tags)](https://img.shields.io/github/v/release/aristanetworks/ansible-cvp) ![License](https://img.shields.io/github/license/aristanetworks/ansible-cvp) [![Collection code testing](https://github.com/aristanetworks/ansible-cvp/actions/workflows/pull-request-management.yml/badge.svg)](https://github.com/aristanetworks/ansible-cvp/actions/workflows/pull-request-management.yml)

ansible_collections/arista/cvp/README.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Ansible Modules for Arista CloudVision Platform
 
 ## About

ansible_collections/arista/cvp/docs/_build/ansible2rst.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+# SKIP LICENSE INSERTION
 # (c) 2012, Jan-Piet Mens <jpmens () gmail.com>
 #
 # Ansible is free software: you can redistribute it and/or modify

ansible_collections/arista/cvp/docs/_build/rst.j2

@@ -1,3 +1,4 @@
+{# SKIP LICENSE INSERTION #}
 .. _@{ module }@:
 
 {% set title = module %}

ansible_collections/arista/cvp/docs/contributing.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Contribute to Arista ansible-cvp collection
 
 Please take a moment to review this document in order to make the contribution

ansible_collections/arista/cvp/docs/faq/containers.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Ansible Execution Environment
 
 ## Ansible EE and builder overview

ansible_collections/arista/cvp/docs/faq/errors.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Common Error messages
 
 > All Ansible error messages should be read from bottom to top.

ansible_collections/arista/cvp/docs/getting-started.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Getting Started
 
 This example outlines how to use `arista.cvp` to create a containers topology on Arista CloudVision.

ansible_collections/arista/cvp/docs/how-to/cvp-authentication.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # CloudVision Authentication
 
 CloudVision supports 2 different types of authentication depending on what kind of instance you are targeting:

ansible_collections/arista/cvp/docs/how-to/debug.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Debug logs
 
 If required, `arista.cvp` collection supports debug log to get more information about process execution and save all these information in a log file.

ansible_collections/arista/cvp/docs/how-to/v1/cv_configlet.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Configure configlets on CloudVision
 
 `cv_configlet` manage configlets on CloudVision:

ansible_collections/arista/cvp/docs/how-to/v1/cv_container.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Configure container on CloudVision
 
 cv_container manage containers on CloudVision:

ansible_collections/arista/cvp/docs/how-to/v1/cv_device.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Configure devices on CloudVision
 
 cv_device manage devices on CloudVision:

ansible_collections/arista/cvp/docs/how-to/v1/cv_facts.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Get facts from CloudVision
 
 `cv_facts` collect Facts from CloudVision:

ansible_collections/arista/cvp/docs/how-to/v3/cv_change_control_v3.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Configure a Change Control on CloudVision
 
 **cv_change_control_v3** manage change controls on CloudVision:

ansible_collections/arista/cvp/docs/how-to/v3/cv_configlet_v3.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Configure configlets on CloudVision (v3)
 
 `cv_configlet_v3` manage configlets on CloudVision:

ansible_collections/arista/cvp/docs/how-to/v3/cv_container_v3.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Configure container on CloudVision (v3)
 
 **cv_container_v3** manages containers on CloudVision. It supports:

ansible_collections/arista/cvp/docs/how-to/v3/cv_device_v3.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Configure devices on CloudVision
 
 **cv_device_v3** manage devices on CloudVision:

ansible_collections/arista/cvp/docs/how-to/v3/cv_facts_v3.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Get provisioning information from CloudVision
 
 **cv_facts_v3** get provisioning information from CloudVision:

ansible_collections/arista/cvp/docs/how-to/v3/cv_image_v3.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Configure Images and Image Bundles on CloudVision
 
 **cv_image_v3** manage devices on CloudVision:

ansible_collections/arista/cvp/docs/how-to/v3/cv_tag_v3.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Tag management on CloudVision
 
 **cv_tag_v3** manage tags on CloudVision:

ansible_collections/arista/cvp/docs/how-to/v3/cv_task_v3.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Execute / Cancel tasks on CloudVision
 
 **cv_task_v3** manage tasks on CloudVision:

ansible_collections/arista/cvp/docs/how-to/v3/cv_validate_v3.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Validate Configlet
 
 **cv_validate_v3** Online and Offline configlet validation:

ansible_collections/arista/cvp/docs/installation/collection-installation.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Collection installation
 
 These instructions are for regular users to install via Ansible Galaxy. To setup a development environment use [these](https://www.avd.sh/en/devel/docs/contribution/overview.html) instructions.

ansible_collections/arista/cvp/docs/installation/requirements.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Requirements
 
 ## Arista EOS version

ansible_collections/arista/cvp/docs/modules/cv_change_control_v3.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_change_control_v3
 
 Change Control management with CloudVision

ansible_collections/arista/cvp/docs/modules/cv_configlet.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_configlet
 
 Create, Delete, or Update CloudVision Portal Configlets.

ansible_collections/arista/cvp/docs/modules/cv_configlet_v3.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_configlet_v3
 
 Create, Delete, or Update CloudVision Portal Configlets.

ansible_collections/arista/cvp/docs/modules/cv_container.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_container
 
 Manage Provisioning topology.

ansible_collections/arista/cvp/docs/modules/cv_container_v3.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_container_v3
 
 Manage Provisioning topology.

ansible_collections/arista/cvp/docs/modules/cv_device.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_device
 
 Provision, Reset, or Update CloudVision Portal Devices.

ansible_collections/arista/cvp/docs/modules/cv_device_v3.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_device_v3
 
 Manage Provisioning topology.

ansible_collections/arista/cvp/docs/modules/cv_facts.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_facts
 
 Collect facts from CloudVision Portal.

ansible_collections/arista/cvp/docs/modules/cv_facts_v3.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_facts_v3
 
 Collect facts from CloudVision

ansible_collections/arista/cvp/docs/modules/cv_image_v3.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_image_v3
 
 EOS Image management with CloudVision

ansible_collections/arista/cvp/docs/modules/cv_tag_v3.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_tag_v3
 
 Create/Assign/Delete/Unassign tags on CVP

ansible_collections/arista/cvp/docs/modules/cv_task.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_task
 
 Execute or Cancel CVP Tasks.

ansible_collections/arista/cvp/docs/modules/cv_task_v3.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_task_v3
 
 Execute or Cancel CVP Tasks.

ansible_collections/arista/cvp/docs/modules/cv_validate_v3.rst.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_validate_v3
 
 CVP/Local configlet Validation

ansible_collections/arista/cvp/docs/release-notes/v1.x.md

@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Release Notes For Ansible CVP 1.x
 
 ## Release v1.1.2