/ home / cisco / cisco.dnac / 6.13.3 / module / nfv_profile_info

cisco.dnac.nfv_profile_info (6.13.3) — module

Information module for Nfv Profile

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get Nfv Profile by id.

API to get NFV network profile.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get Nfv Profile by id
  cisco.dnac.nfv_profile_info:
    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}}"
    offset: 0
    limit: 0
    name: string
    id: string
  register: result

Inputs

    
id:
    description:
    - Id path parameter. ID of network profile to retrieve.
    type: str

name:
    description:
    - Name query parameter. Name of network profile to be retrieved.
    type: str

limit:
    description:
    - Limit query parameter. Number of profile to be retrieved.
    type: int

offset:
    description:
    - Offset query parameter. Offset/starting row.
    type: int

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": [\n    {\n      \"profileName\": \"string\",\n     \
    \ \"id\": \"string\",\n      \"device\": [\n        {\n          \"deviceType\"\
    : \"string\",\n          \"deviceTag\": \"string\",\n          \"serviceProviderProfile\"\
    : [\n            {\n              \"linkType\": \"string\",\n              \"\
    connect\": true,\n              \"connectDefaultGatewayOnWan\": true,\n      \
    \        \"serviceProvider\": \"string\"\n            }\n          ],\n      \
    \    \"directInternetAccessForFirewall\": true,\n          \"services\": [\n \
    \           {\n              \"serviceType\": \"string\",\n              \"profileType\"\
    : \"string\",\n              \"serviceName\": \"string\",\n              \"imageName\"\
    : \"string\",\n              \"vNicMapping\": [\n                {\n         \
    \         \"networkType\": \"string\",\n                  \"assignIpAddressToNetwork\"\
    : true\n                }\n              ],\n              \"firewallMode\": \"\
    string\"\n            }\n          ],\n          \"customNetworks\": [\n     \
    \       {\n              \"networkName\": \"string\",\n              \"servicesToConnect\"\
    : [\n                {\n                  \"serviceName\": \"string\"\n      \
    \          }\n              ],\n              \"connectionType\": \"string\",\n\
    \              \"vlanMode\": \"string\",\n              \"vlanId\": \"string\"\
    \n            }\n          ],\n          \"vlanForL2\": [\n            {\n   \
    \           \"vlanType\": \"string\",\n              \"vlanId\": \"string\",\n\
    \              \"vlanDescription\": \"string\"\n            }\n          ],\n\
    \          \"customTemplate\": [\n            {\n              \"deviceType\"\
    : \"string\",\n              \"template\": \"string\",\n              \"templateType\"\
    : \"string\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}\n"
  type: dict