ciena.mcp.discovery_api_managementsessions (1.0.4) — module

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_managementsessions

Requirements

• python >= 3.6

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 current index of data to return
    - Used by I(state=['get'])
    type: str

sortBy:
    description:
    - (Optional) List of comma separated fields by which to sort the result. Fields require
      full path (i.e. data.attributes.field). A dash or negative sign before a field indicates
      descending order; by default ascending order is used
    - 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

longName:
    description:
    - (Optional) List of comma separated longName values
    - 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

profileId:
    description:
    - (Optional) List of NE security connection profile identifiers
    - Used by I(state=['get'])
    type: str

typeGroup:
    description:
    - (Optional) List of the management session typeGroup
    - Used by I(state=['get'])
    type: str

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

searchText:
    description:
    - (Optional) The searchable text
    - Used by I(state=['get'])
    type: str

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

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

displayState:
    description:
    - '(Optional) List of comma separated display states. The allowed values are: Pending,
      Connecting, Not connected, Connected, Failed'
    - Used by I(state=['get'])
    type: str

resourceType:
    description:
    - (Optional) List of the management session resourceType
    - Used by I(state=['get'])
    type: str

searchFields:
    description:
    - (Optional) List of comma separated fields to search on. If none are specified, all
      supported fields are implied. Fields require full path (e.g. data.attributes.name)
    - Used by I(state=['get'])
    type: str

metaDataFields:
    description:
    - '(Optional) List of meta data to be included. The allowed values are: resourceType,
      associationState, discoveryState, displayState, typeGroup, profileName, resourcePartitionInfo,
      shortResourceType'
    - Used by I(state=['get'])
    type: str

associationState:
    description:
    - '(Optional) List of the management session associationState. The valid values are:
      GOA, LOA'
    - Used by I(state=['get'])
    type: str

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

shortResourceType:
    description:
    - (Optional) List of the management session shortResourceType
    - Used by I(state=['get'])
    type: str

resourcePartitionInfo:
    description:
    - (Optional) List of comma separated resource partitions, 'none' to search unpartitioned
      resource if user has sufficient privilege
    - Used by I(state=['get'])
    type: str

associationStateQualifier:
    description:
    - (Optional) List of associationStateQualifiers. The allowed values are MANUAL, NETWORK,
      SYSTEM
    - Used by I(state=['get'])
    type: str

displayPreferredConnectionName:
    description:
    - (Optional) Name of preferred connection
    - Used by I(state=['get'])
    type: str

associationStateQualifierReason:
    description:
    - (Optional) Reason for putting a Management Session to 'inMaintenance'.
    - Used by I(state=['get'])
    type: str

displayAlternativeConnectionIPs:
    description:
    - (Optional) List of comma seperated display alternative connection IPs
    - Used by I(state=['get'])
    type: str

displayAlternativeConnectionNames:
    description:
    - (Optional) List of comma seperated display alternative connection names
    - Used by I(state=['get'])
    type: str