ospfarea_list#
Collection Note
This module is part of the nokia.eda_protocols_v1 collection. To install the collection, use:
Added in version1.0.0. Synopsis#
- Lists the OSPFArea resources.
Parameters#
| Parameter | Defaults / Choices | Comments |
|---|---|---|
| authToken str required | HTTP authentication (Bearer authentication) string in the format of "Bearer TOKEN". Required unless state is cronly. | |
| baseUrl str required | EDA API URL including the schema and port (if non standard for the provided schema). Example - https://try.eda.demo:9443. Required unless state is cronly. | |
| caPath str required | A path to the PEM-encoded CA certificate to use for TLS verification. Required unless state is cronly. | |
| detailLevel str | The detail level to keep in the transaction log for the transaction resulting from this request. | |
| disableBatching bool | If true, prevents the transaction resulting from this request from being bundled with others. | |
| fields str | A comma-separated list of resource fields to fetch/return. If unspecified, all fields are fetched. If empty, only key-fields are fetched. | |
| filter str | An EQL where expression that will be used to filter the set of resources returned. | |
| label-selector str | {'Deprecated': 'a label selector string to filter the set of CRs deleted based on CR labels'} | |
| labelSelector str | A label selector string to filter the set of CRs deleted based on CR labels | |
| name str required | Name of the OSPFArea. Required when state is query or absent. | |
| namespace str required | The namespace to use when querying or removing the resource. Required when state is query or absent. | |
| state str required | Choices: absent, query | State of the requested resource object. |
| tlsSkipVerify bool required | A flag to control the TLS verification of the session. Required unless state is cronly. |
Authors#
- Roman Dodin (@hellt)