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

Requirements

• python >= 3.6

Inputs

    
p:
    description:
    - Optional query parameter to define a partial string match filter using property:value
      syntax
    - Used by I(state=['get', 'head'])
    type: str

q:
    description:
    - Optional query parameter to define a query filter using property:value syntax
    - Used by I(state=['get', 'head'])
    type: str

rpId:
    description:
    - Resource provider managing this domain
    - Used by I(state=['post'])
    type: str

limit:
    description:
    - The maximum number of elements to return in a single paged request
    - Used by I(state=['get', 'head'])
    type: int

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

title:
    description:
    - Descriptive name/title of domain
    - Used by I(state=['post'])
    type: str

offset:
    description:
    - Requested offset within the total result set to be the first element in the paged
      response
    - Used by I(state=['get', 'head'])
    type: int

address:
    description:
    - Address of the domain
    - 'Validate attributes are:'
    - ' - C(city) (str): City'
    - ' - C(country) (str): Country'
    - ' - C(latitude) (number): Latitude'
    - ' - C(longitude) (number): Longitude'
    - ' - C(state) (str): State/province'
    - ' - C(street) (str): Street'
    - ' - C(zip) (str): Postal/zip code'
    - Used by I(state=['post'])
    type: dict

tenantId:
    description:
    - Orchestrator tenant ID for the domain owner (if unspecified defaults to requester)
    - Used by I(state=['post'])
    type: str

validate:
    description:
    - Whether to use a custom validator
    - Used by I(state=['post'])
    type: bool

accessUrl:
    description:
    - Access URL to the domain
    - Used by I(state=['post'])
    type: str

obfuscate:
    description:
    - If true, schema obfuscated values will be replaced with a fixed string in the response.
    - Used by I(state=['get', 'head', 'post'])
    type: bool

pageToken:
    description:
    - String pagination token returned from a previous query that encodes query information
      in order to optimize a
    - subsequent request for a page of results. The token includes the limit and offset
      parameters for the next page, but one or
    - both can be included to override the encoded values
    - Used by I(state=['get', 'head'])
    type: str

properties:
    description:
    - Properties the domain
    - 'Validate attributes are:'
    - ' - C(obj) (list): '
    - Used by I(state=['post'])
    type: dict

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

operationMode:
    description:
    - Operation mode of this domain
    - Used by I(state=['post'])
    type: str

onlyEnableTypes:
    description:
    - When non-empty, only enable these resource types in the domain
    - Used by I(state=['post'])
    type: list