ciena.mcp.configmgmt_api_v2_profiles (1.0.4) — module

Handle resource of type configmgmt_api_v2_profiles

| "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 configmgmt_api_v2_profiles


Requirements

Inputs

    
name:
    description:
    - List of profile names
    - Used by I(state=['get', 'post'])
    type: str

port:
    description:
    - The NE Maintenance profiles by port to be retrieved.
    - Used by I(state=['get', 'post'])
    type: int

limit:
    description:
    - 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. A dash or
      negative sign before a field indicates descending order; by default ascending order
      is used
    - Used by I(state=['get'])
    type: str

sshPort:
    description:
    - The NE Maintenance profiles by sshPort to be retrieved.
    - Used by I(state=['get'])
    type: int

userName:
    description:
    - Used by I(state=['post'])
    type: str

ipAddress:
    description:
    - (Optional) Ip Address of Network Construct
    - Used by I(state=['get', 'post'])
    type: str

profileId:
    description:
    - List of profile Ids
    - Used by I(state=['get'])
    type: str

typeGroup:
    description:
    - The NE Maintenance profiles by typeGroup to be retrieved.
    - Used by I(state=['get'])
    type: str

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

profileType:
    description:
    - The NE Maintenance profiles by profile type to be retrieved.
    - Used by I(state=['get', 'post'])
    type: str

protocolType:
    description:
    - The NE Maintenance profiles by protocol type to be retrieved.
    - Used by I(state=['get', 'post'])
    type: str

searchFields:
    description:
    - (Optional) List of comma separated fields to search on. If none are specified, all
      supported fields are implied.
    - Used by I(state=['get'])
    type: str

userPassword:
    description:
    - Used by I(state=['post'])
    type: str

imageLocation:
    description:
    - Used by I(state=['post'])
    type: str

releaseNumber:
    description:
    - The NE Maintenance upgrade profiles by release number to be retrieved.
    - Used by I(state=['get'])
    type: str

storageMethod:
    description:
    - The NE Maintenance profiles by storage method to be retrieved.
    - Used by I(state=['get', 'post'])
    type: str

metaDataFields:
    description:
    - '(Optional) List of meta data to be included. The allowed values are: profileType,
      protocolType, storageMethod'
    - Used by I(state=['get'])
    type: str