.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.nfv_provision_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.nfv_provision module -- Resource module for Nfv Provision ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.18.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.nfv_provision`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 3.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Nfv Provision. - Design and Provision single/multi NFV device with given site/area/building/floor . .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.nfv_provision_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.2 - python \>= 3.9 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning: .. rst-class:: ansible-option-title **provisioning** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's provisioning. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device: .. rst-class:: ansible-option-title **device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/customnetworks: .. rst-class:: ansible-option-title **customNetworks** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's customNetworks. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/customnetworks/ipaddresspool: .. rst-class:: ansible-option-title **ipAddressPool** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address pool of sub pool (eg 175.175.140.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/customnetworks/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of custom network (eg cust-1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/customnetworks/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Port for custom network (eg 443). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/deviceserialnumber: .. rst-class:: ansible-option-title **deviceSerialNumber** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Serial number of device (eg FGL210710QY). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/ip: .. rst-class:: ansible-option-title **ip** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address of the device (eg 172.20.126.90). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/serviceproviders: .. rst-class:: ansible-option-title **serviceProviders** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's serviceProviders. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/serviceproviders/serviceprovider: .. rst-class:: ansible-option-title **serviceProvider** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the service provider (eg Airtel). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/serviceproviders/waninterface: .. rst-class:: ansible-option-title **wanInterface** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's wanInterface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/serviceproviders/waninterface/bandwidth: .. rst-class:: ansible-option-title **bandwidth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Bandwidth limit (eg 100). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/serviceproviders/waninterface/gateway: .. rst-class:: ansible-option-title **gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Gateway (eg 175.175.190.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/serviceproviders/waninterface/interfacename: .. rst-class:: ansible-option-title **interfaceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the interface (eg GE0-0). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/serviceproviders/waninterface/ipaddress: .. rst-class:: ansible-option-title **ipAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address (eg 175.175.190.205). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/serviceproviders/waninterface/subnetmask: .. rst-class:: ansible-option-title **subnetmask** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Subnet mask (eg 255.255.255.0). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/services: .. rst-class:: ansible-option-title **services** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's services. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/services/adminpasswordhash: .. rst-class:: ansible-option-title **adminPasswordHash** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Admin password hash. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/services/centralmanagerip: .. rst-class:: ansible-option-title **centralManagerIP** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
WAAS Package needs to be installed to populate Central Manager IP automatically. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/services/centralregistrationkey: .. rst-class:: ansible-option-title **centralRegistrationKey** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Central registration key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/services/commonkey: .. rst-class:: ansible-option-title **commonKey** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Common key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/services/disk: .. rst-class:: ansible-option-title **disk** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of disk type (eg internal). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/services/mode: .. rst-class:: ansible-option-title **mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of firewall (eg transparent). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/services/systemip: .. rst-class:: ansible-option-title **systemIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
System IP. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/services/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of service (eg ISR). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/subpools: .. rst-class:: ansible-option-title **subPools** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's subPools. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/subpools/gateway: .. rst-class:: ansible-option-title **gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address for gate way (eg 175.175.140.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/subpools/ipsubnet: .. rst-class:: ansible-option-title **ipSubnet** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP pool cidir (eg 175.175.140.0). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/subpools/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the ip sub pool (eg; Lan-65). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/subpools/parentpoolname: .. rst-class:: ansible-option-title **parentPoolName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of parent pool (global pool name). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/subpools/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Tyep of ip sub pool (eg Lan). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/tagname: .. rst-class:: ansible-option-title **tagName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of device tag (eg dev1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/templateparam: .. rst-class:: ansible-option-title **templateParam** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's templateParam. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/templateparam/asav: .. rst-class:: ansible-option-title **asav** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's asav. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/templateparam/asav/var1: .. rst-class:: ansible-option-title **var1** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Variable for asav template (eg "test" "Hello asav"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/templateparam/nfvis: .. rst-class:: ansible-option-title **nfvis** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's nfvis. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/templateparam/nfvis/var1: .. rst-class:: ansible-option-title **var1** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Variable for nfvis template (eg "test" "Hello nfvis"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's vlan. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/vlan/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Vlan id(e .4018). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/vlan/interfaces: .. rst-class:: ansible-option-title **interfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Interface (eg GigabitEathernet1/0). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/vlan/network: .. rst-class:: ansible-option-title **network** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network name to connect (eg lan-net). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/device/vlan/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Vlan type(eg. Access or Trunk). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site: .. rst-class:: ansible-option-title **site** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/area: .. rst-class:: ansible-option-title **area** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's area. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/area/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the area (eg Area1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/area/parentname: .. rst-class:: ansible-option-title **parentName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Parent name of the area to be created. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/building: .. rst-class:: ansible-option-title **building** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's building. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/building/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Address of the building to be created. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/building/latitude: .. rst-class:: ansible-option-title **latitude** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Latitude coordinate of the building (eg 37.338). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/building/longitude: .. rst-class:: ansible-option-title **longitude** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Longitude coordinate of the building (eg -121.832). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/building/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the building (eg building1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/building/parentname: .. rst-class:: ansible-option-title **parentName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Address of the building to be created. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/floor: .. rst-class:: ansible-option-title **floor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's floor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/floor/height: .. rst-class:: ansible-option-title **height** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Height of the floor (eg 15). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/floor/length: .. rst-class:: ansible-option-title **length** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Length of the floor (eg 100). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/floor/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the floor (eg floor-1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/floor/parentname: .. rst-class:: ansible-option-title **parentName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Parent name of the floor to be created. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/floor/rfmodel: .. rst-class:: ansible-option-title **rfModel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of floor (eg Cubes And Walled Offices). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/floor/width: .. rst-class:: ansible-option-title **width** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Width of the floor (eg 100). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-provisioning/site/siteprofilename: .. rst-class:: ansible-option-title **siteProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of site profile to be provision with device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile: .. rst-class:: ansible-option-title **siteProfile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's siteProfile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device: .. rst-class:: ansible-option-title **device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customnetworks: .. rst-class:: ansible-option-title **customNetworks** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's customNetworks. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customnetworks/connectiontype: .. rst-class:: ansible-option-title **connectionType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of network connection from custom network (eg lan). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customnetworks/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of custom network (eg cust-1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customnetworks/networkmode: .. rst-class:: ansible-option-title **networkMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network mode (eg Access or Trunk). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customnetworks/servicestoconnect: .. rst-class:: ansible-option-title **servicesToConnect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's servicesToConnect. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customnetworks/servicestoconnect/service: .. rst-class:: ansible-option-title **service** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of service to be connected to the custom network (eg router-1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customnetworks/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Vlan id for the custom network(eg 4000). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customservices: .. rst-class:: ansible-option-title **customServices** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's customServices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customservices/applicationtype: .. rst-class:: ansible-option-title **applicationType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Application type of custom service (eg LINUX). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customservices/imagename: .. rst-class:: ansible-option-title **imageName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Image name of custom service (eg redhat7.tar.gz.tar.gz). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customservices/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of custom service (eg LINUX-1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customservices/profile: .. rst-class:: ansible-option-title **profile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Profile type of service (eg rhel7-medium). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customservices/topology: .. rst-class:: ansible-option-title **topology** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's topology. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customservices/topology/assignip: .. rst-class:: ansible-option-title **assignIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Assign ip to network (eg true). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customservices/topology/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of connection from custom service(eg wan-net). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customservices/topology/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of connection from custom service (eg wan, lan or internal). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customtemplate: .. rst-class:: ansible-option-title **customTemplate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's customTemplate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customtemplate/devicetype: .. rst-class:: ansible-option-title **deviceType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of the device(eg NFVIS). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/customtemplate/template: .. rst-class:: ansible-option-title **template** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the template(eg NFVIS template). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/devicetype: .. rst-class:: ansible-option-title **deviceType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the device used in creating nfv profile(eg ENCS5400). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/dia: .. rst-class:: ansible-option-title **dia** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Direct internet access value should be boolean (eg false). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/serviceproviders: .. rst-class:: ansible-option-title **serviceProviders** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's serviceProviders. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/serviceproviders/connect: .. rst-class:: ansible-option-title **connect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Connection of service provider and device value should be boolean (eg true). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/serviceproviders/defaultgateway: .. rst-class:: ansible-option-title **defaultGateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Default gateway connect value as boolean (eg true). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/serviceproviders/linktype: .. rst-class:: ansible-option-title **linkType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of connection type(eg GigabitEthernet). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/serviceproviders/serviceprovider: .. rst-class:: ansible-option-title **serviceProvider** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the service provider(eg Airtel). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services: .. rst-class:: ansible-option-title **services** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's services. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services/imagename: .. rst-class:: ansible-option-title **imageName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of image (eg isrv-universalk9.16.06.02.tar.gz). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services/mode: .. rst-class:: ansible-option-title **mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of firewall (eg routed, transparent). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the service (eg isrv). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services/profile: .. rst-class:: ansible-option-title **profile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Profile type of service (eg ISRv-mini). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services/topology: .. rst-class:: ansible-option-title **topology** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's topology. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services/topology/assignip: .. rst-class:: ansible-option-title **assignIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Assign ip address to network (eg true). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services/topology/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of connection (eg wan-net). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services/topology/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of connection (eg wan, lan or internal). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/services/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Service type (eg ISRV). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/tagname: .. rst-class:: ansible-option-title **tagName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Tag name(eg dev1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Provision's vlan. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/vlan/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Vlan id(eg.4018). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/device/vlan/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Vlan type(eg. Access or Trunk). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-siteprofile/siteprofilename: .. rst-class:: ansible-option-title **siteProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the profile to create site profile profile( eg profile-1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are site\_design.SiteDesign.provision\_nfv, - Paths used are post /dna/intent/api/v1/business/nfv, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Site Design ProvisionNFV `_ Complete reference of the ProvisionNFV API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.dnac.nfv_provision: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" headers: '{{my_headers | from_json}}' provisioning: - device: - customNetworks: - ipAddressPool: string name: string port: string deviceSerialNumber: string ip: string serviceProviders: - serviceProvider: string wanInterface: bandwidth: string gateway: string interfaceName: string ipAddress: string subnetmask: string services: - adminPasswordHash: string centralManagerIP: string centralRegistrationKey: string commonKey: string disk: string mode: string systemIp: string type: string subPools: - gateway: string ipSubnet: string name: string parentPoolName: string type: string tagName: string templateParam: asav: var1: string nfvis: var1: string vlan: - id: string interfaces: string network: string type: string site: area: name: string parentName: string building: address: string latitude: 0 longitude: 0 name: string parentName: string floor: height: 0 length: 0 name: string parentName: string rfModel: string width: 0 siteProfileName: string siteProfile: - device: - customNetworks: - connectionType: string name: string networkMode: string servicesToConnect: - service: string vlan: string customServices: - applicationType: string imageName: string name: string profile: string topology: assignIp: string name: string type: string customTemplate: - deviceType: string template: string deviceType: string dia: true serviceProviders: - connect: true defaultGateway: true linkType: string serviceProvider: string services: - imageName: string mode: string name: string profile: string topology: assignIp: string name: string type: string type: string tagName: string vlan: - id: string type: string siteProfileName: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_provision_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors