racampos.dnac.nfv_profile (0.0.1) — module

Manage NfvProfile objects of SiteDesign

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

API to create network profile for different NFV topologies.

API to get NFV network profile.

API to delete nfv network profile.

API to update a NFV Network profile.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create_nfv_profile
  cisco.dnac.nfv_profile:
    state: create  # required
    device:  # required
    - deviceType: SomeValue  # string, required
      deviceTag: SomeValue  # string, required
      serviceProviderProfile:  # required
      - serviceProvider: SomeValue  # string, required
        linkType: SomeValue  # string, required
        connect: True  # boolean, required
        connectDefaultGatewayOnWan: True  # boolean, required
      directInternetAccessForFirewall: True  # boolean, required
      services:  # required
      - serviceType: SomeValue  # string, required
        profileType: SomeValue  # string, required
        serviceName: SomeValue  # string, required
        imageName: SomeValue  # string, required
        vNicMapping:  # required
        - networkType: SomeValue  # string, required
          assignIpAddressToNetwork: SomeValue  # string
        firewallMode: SomeValue  # string
      customNetworks:
      - networkName: SomeValue  # string, required
        servicesToConnect:  # required
        - serviceName: SomeValue  # string, required
        connectionType: SomeValue  # string, required
        vlanMode: SomeValue  # string, required
        vlanId: 1  #  number, required
      vlanForL2:
      - vlanType: SomeValue  # string, required
        vlanId: 1  #  number, required
        vlanDescription: SomeValue  # string, required
      customTemplate:
      - deviceType: SomeValue  # string, required
        template: SomeValue  # string, required
        templateType: SomeValue  # string, required
    profileName: SomeValue  # string, required
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_nfv_profile
  cisco.dnac.nfv_profile:
    state: query  # required
    id: SomeValue  # string, required
    limit: SomeValue  # string
    name: SomeValue  # string
    offset: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: delete_nfv_profile
  cisco.dnac.nfv_profile:
    state: delete  # required
    id: SomeValue  # string, required
    name: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: update_nfv_profile
  cisco.dnac.nfv_profile:
    state: update  # required
    id: SomeValue  # string, required
    device:  # required
    - deviceTag: SomeValue  # string, required
      directInternetAccessForFirewall: True  # boolean, required
      currentDeviceTag: SomeValue  # string, required
      services:
      - serviceType: SomeValue  # string, required
        profileType: SomeValue  # string, required
        serviceName: SomeValue  # string, required
        imageName: SomeValue  # string, required
        vNicMapping:  # required
        - networkType: SomeValue  # string, required
          assignIpAddressToNetwork: SomeValue  # string
        firewallMode: SomeValue  # string
      customNetworks:
      - networkName: SomeValue  # string, required
        servicesToConnect:  # required
        - serviceName: SomeValue  # string, required
        connectionType: SomeValue  # string, required
        vlanMode: SomeValue  # string, required
        vlanId: 1  #  number, required
      vlanForL2:
      - vlanType: SomeValue  # string, required
        vlanId: 1  #  number, required
        vlanDescription: SomeValue  # string, required
      customTemplate:
      - deviceType: SomeValue  # string, required
        template: SomeValue  # string, required
        templateType: SomeValue  # string, required
    name: SomeValue  # string

Inputs

    
id:
    description:
    - ID of network profile to retrieve.
    - Id of nfv network profile to delete. .
    - Id of the NFV profile to be updated.
    required: true
    type: str

name:
    description:
    - Name of network profile to be retrieved.
    - Nameof nfv network profile to delete. .
    - Name of the profile to be updated.
    type: str

limit:
    description:
    - Number of profile to be retrieved.
    type: str

device:
    description:
    - Device, property of the request body (list of objects).
    elements: dict
    required: true
    suboptions:
      currentDeviceTag:
        description:
        - It is the nfv profile's currentDeviceTag.
        required: true
        type: str
      customNetworks:
        description:
        - It is the nfv profile's customNetworks.
        elements: dict
        suboptions:
          connectionType:
            description:
            - It is the nfv profile's connectionType.
            - Required for states create and update.
            type: str
          networkName:
            description:
            - It is the nfv profile's networkName.
            - Required for states create and update.
            type: str
          servicesToConnect:
            description:
            - It is the nfv profile's servicesToConnect.
            elements: dict
            required: true
            suboptions:
              serviceName:
                description:
                - It is the nfv profile's serviceName.
                - Required for states create and update.
                type: str
            type: list
          vlanId:
            description:
            - It is the nfv profile's vlanId.
            - Required for states create and update.
            type: int
          vlanMode:
            description:
            - It is the nfv profile's vlanMode.
            - Required for states create and update.
            type: str
        type: list
      customTemplate:
        description:
        - It is the nfv profile's customTemplate.
        elements: dict
        suboptions:
          deviceType:
            description:
            - It is the nfv profile's deviceType.
            - Required for states create and update.
            type: str
          template:
            description:
            - It is the nfv profile's template.
            - Required for states create and update.
            type: str
          templateType:
            description:
            - It is the nfv profile's templateType.
            - Required for states create and update.
            type: str
        type: list
      deviceTag:
        description:
        - It is the nfv profile's deviceTag.
        - Required for states create and update.
        type: str
      deviceType:
        description:
        - It is the nfv profile's deviceType.
        required: true
        type: str
      directInternetAccessForFirewall:
        description:
        - It is the nfv profile's directInternetAccessForFirewall.
        - Required for states create and update.
        type: bool
      serviceProviderProfile:
        description:
        - It is the nfv profile's serviceProviderProfile.
        elements: dict
        required: true
        suboptions:
          connect:
            description:
            - It is the nfv profile's connect.
            required: true
            type: bool
          connectDefaultGatewayOnWan:
            description:
            - It is the nfv profile's connectDefaultGatewayOnWan.
            required: true
            type: bool
          linkType:
            description:
            - It is the nfv profile's linkType.
            required: true
            type: str
          serviceProvider:
            description:
            - It is the nfv profile's serviceProvider.
            required: true
            type: str
        type: list
      services:
        description:
        - It is the nfv profile's services.
        elements: dict
        required: true
        suboptions:
          firewallMode:
            description:
            - It is the nfv profile's firewallMode.
            type: str
          imageName:
            description:
            - It is the nfv profile's imageName.
            - Required for states create and update.
            type: str
          profileType:
            description:
            - It is the nfv profile's profileType.
            - Required for states create and update.
            type: str
          serviceName:
            description:
            - It is the nfv profile's serviceName.
            - Required for states create and update.
            type: str
          serviceType:
            description:
            - It is the nfv profile's serviceType.
            - Required for states create and update.
            type: str
          vNicMapping:
            description:
            - It is the nfv profile's vNicMapping.
            elements: dict
            required: true
            suboptions:
              assignIpAddressToNetwork:
                description:
                - It is the nfv profile's assignIpAddressToNetwork.
                type: str
              networkType:
                description:
                - It is the nfv profile's networkType.
                - Required for states create and update.
                type: str
            type: list
        type: list
      vlanForL2:
        description:
        - It is the nfv profile's vlanForL2.
        elements: dict
        suboptions:
          vlanDescription:
            description:
            - It is the nfv profile's vlanDescription.
            - Required for states create and update.
            type: str
          vlanId:
            description:
            - It is the nfv profile's vlanId.
            - Required for states create and update.
            type: int
          vlanType:
            description:
            - It is the nfv profile's vlanType.
            - Required for states create and update.
            type: str
        type: list
    type: list

offset:
    description:
    - Offset/starting row.
    type: str

profileName:
    description:
    - Site Profile Name, property of the request body.
    - Required for state create.
    type: str

Outputs

create_nfv_profile:
  contains: null
  description: API to create network profile for different NFV topologies.
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
delete_nfv_profile:
  contains: null
  description: API to delete nfv network profile.
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
get_nfv_profile:
  contains: null
  description: API to get NFV network profile.
  response:
    contains:
      device:
        contains:
          customNetworks:
            contains:
              connectionType:
                description: It is the nfv profile's connectionType.
                returned: always
                sample: <connectiontype>
                type: str
              networkName:
                description: It is the nfv profile's networkName.
                returned: always
                sample: <networkname>
                type: str
              servicesToConnect:
                contains:
                  serviceName:
                    description: It is the nfv profile's serviceName.
                    returned: always
                    sample: <servicename>
                    type: str
                description: It is the nfv profile's servicesToConnect.
                returned: always
                type: list
              vlanId:
                description: It is the nfv profile's vlanId.
                returned: always
                sample: <vlanid>
                type: str
              vlanMode:
                description: It is the nfv profile's vlanMode.
                returned: always
                sample: <vlanmode>
                type: str
            description: It is the nfv profile's customNetworks.
            returned: always
            type: list
          customTemplate:
            contains:
              deviceType:
                description: It is the nfv profile's deviceType.
                returned: always
                sample: <devicetype>
                type: str
              template:
                description: It is the nfv profile's template.
                returned: always
                sample: <template>
                type: str
              templateType:
                description: It is the nfv profile's templateType.
                returned: always
                sample: <templatetype>
                type: str
            description: It is the nfv profile's customTemplate.
            returned: always
            type: list
          deviceTag:
            description: It is the nfv profile's deviceTag.
            returned: always
            sample: <devicetag>
            type: str
          deviceType:
            description: It is the nfv profile's deviceType.
            returned: always
            sample: <devicetype>
            type: str
          directInternetAccessForFirewall:
            description: It is the nfv profile's directInternetAccessForFirewall.
            returned: always
            sample: false
            type: bool
          serviceProviderProfile:
            contains:
              connect:
                description: It is the nfv profile's connect.
                returned: always
                sample: false
                type: bool
              connectDefaultGatewayOnWan:
                description: It is the nfv profile's connectDefaultGatewayOnWan.
                returned: always
                sample: false
                type: bool
              linkType:
                description: It is the nfv profile's linkType.
                returned: always
                sample: <linktype>
                type: str
              serviceProvider:
                description: It is the nfv profile's serviceProvider.
                returned: always
                sample: <serviceprovider>
                type: str
            description: It is the nfv profile's serviceProviderProfile.
            returned: always
            type: list
          services:
            contains:
              firewallMode:
                description: It is the nfv profile's firewallMode.
                returned: always
                sample: <firewallmode>
                type: str
              imageName:
                description: It is the nfv profile's imageName.
                returned: always
                sample: <imagename>
                type: str
              profileType:
                description: It is the nfv profile's profileType.
                returned: always
                sample: <profiletype>
                type: str
              serviceName:
                description: It is the nfv profile's serviceName.
                returned: always
                sample: <servicename>
                type: str
              serviceType:
                description: It is the nfv profile's serviceType.
                returned: always
                sample: <servicetype>
                type: str
              vNicMapping:
                contains:
                  assignIpAddressToNetwork:
                    description: It is the nfv profile's assignIpAddressToNetwork.
                    returned: always
                    sample: false
                    type: bool
                  networkType:
                    description: It is the nfv profile's networkType.
                    returned: always
                    sample: <networktype>
                    type: str
                description: It is the nfv profile's vNicMapping.
                returned: always
                type: list
            description: It is the nfv profile's services.
            returned: always
            type: list
          vlanForL2:
            contains:
              vlanDescription:
                description: It is the nfv profile's vlanDescription.
                returned: always
                sample: <vlandescription>
                type: str
              vlanId:
                description: It is the nfv profile's vlanId.
                returned: always
                sample: <vlanid>
                type: str
              vlanType:
                description: It is the nfv profile's vlanType.
                returned: always
                sample: <vlantype>
                type: str
            description: It is the nfv profile's vlanForL2.
            returned: always
            type: list
        description: It is the nfv profile's device.
        returned: always
        type: list
      id:
        description: It is the nfv profile's id.
        returned: always
        sample: '478012'
        type: str
      profileName:
        description: It is the nfv profile's profileName.
        returned: always
        sample: <profilename>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
update_nfv_profile:
  contains: null
  description: API to update a NFV Network profile.
  executionId:
    description: Execution Id, property of the response body.
    returned: changed
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: changed
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: changed
    sample: <message>
    type: str
  returned: changed
  type: dict

See also