ciena.mcp.discovery_api_v3_managementsessions (1.0.4) — module

Handle resource of type discovery_api_v3_managementsessions

| "added in version" 1.0.0 of ciena.mcp"

Authors: unknown

Install collection

Install with ansible-galaxy collection install ciena.mcp:==1.0.4


Add to requirements.yml

  collections:
    - name: ciena.mcp
      version: 1.0.4

Description

Handle resource of type discovery_api_v3_managementsessions


Requirements

Inputs

    
data:
    description:
    - 'Validate attributes are:'
    - ' - C(attributes) (dict): '
    - ' - C(id) (str): The unique identifier for the NetworkConstruct resource'
    - ' - C(relationships) (dict): The relationships of a managmemnt session'
    - ' - C(type) (str): The management session resource type'
    - Used by I(state=['post'])
    type: dict

name:
    description:
    - (Optional) List of comma separated name values
    - Used by I(state=['get'])
    type: str

limit:
    description:
    - (Optional) The size of a returned page
    - Used by I(state=['get'])
    type: str

state:
    choices:
    - get
    - post
    description: []
    type: str

offset:
    description:
    - (Optional) Offset for the second page
    - Used by I(state=['get'])
    type: str

states:
    description:
    - '(Optional) List of comma separated discoveryStates. <p> Valid values are: <table><tr><td>PENDING</td><td>
      - prior to enrollment</td></tr><tr><td>AUTO_DISCOVERED</td><td> - prior to enrollment
      and added by the enrollment of another network element</td></tr><tr><td>VALIDATING</td><td>
      - attempting to communicate with the network element</td></tr><tr><td>VALIDATING_FAILED</td><td>
      - communication with the network element failed</td></tr><tr><td>CONNECTING</td><td>
      - creating a session to the network element</td></tr><tr><td>POKING</td><td> - checking
      available accesses to the network element</td></tr><tr><td>CONNECTED</td><td> -
      session established with network element</td></tr><tr><td>DISCOVERING</td><td> -
      retrieving session data from network element</td></tr><tr><td>COMPLETED</td><td>
      - management session is fully operational and connected to the network element</td></tr><tr><td>DISCOVERY_RETRY</td><td>
      - failed to retrieve session data from the network element</td></tr><tr><td>CHANGE_SESSION</td><td>
      - attempting to changing the active session to the network element</td></tr><tr><td>DEENROLLING</td><td>
      - disconnecting from the network element and removing the management session</td></tr></table>'
    - Used by I(state=['get'])
    type: str

aliasName:
    description:
    - (Optional) Key that holds the alias name
    - Used by I(state=['get'])
    type: str

ipAddress:
    description:
    - (Optional) Ip Address of management sessions
    - Used by I(state=['get'])
    type: str

aliasValue:
    description:
    - (Optional) List of alias name values
    - Used by I(state=['get'])
    type: str