ciena.mcp.nsi_api_v1_search_groups (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 nsi_api_v1_search_groups

Requirements

• python >= 3.6

Inputs

    
id:
    description:
    - (Optional) Comma separated list of Group identifiers to retrieve
    - Used by I(state=['get'])
    type: str

name:
    description:
    - (Optional) Comma separated list of group names to retrieve
    - Used by I(state=['get'])
    type: str

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

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

fields:
    description:
    - (Optional) List of comma separated fields to be included in the response. Fields
      require full path (i.e. data.attributes.field)
    - Used by I(state=['get'])
    type: str

offset:
    description:
    - (Optional) Offset for current index of data to return
    - Used by I(state=['get'])
    type: str

groupType:
    description:
    - (Optional) Comma separated list of groupTypes to retrieve
    - Used by I(state=['get'])
    type: str

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

parentGroup:
    description:
    - (Optional) Comma separated list of parentGroups to retrieve
    - Used by I(state=['get'])
    type: str

searchFields:
    description:
    - (Optional) List of comma separated fields to search with, combined with searchText.
      Fields require full path (i.e. data.attributes.field)
    - Used by I(state=['get'])
    type: str