getSubInterfaceList
The getSubInterfaceList operation handles configuration related to SubInterface model.
Path Parameters
Parameter |
Required |
Type |
Description |
parentId |
True |
string | |
Query Parameters
Parameter |
Required |
Type |
Description |
offset |
False |
integer | An integer representing the index of the first requested object. Index starts from 0. If not specified, the returned objects will start from index 0 |
limit |
False |
integer | An integer representing the maximum amount of objects to return. If not specified, the maximum amount is 10 |
sort |
False |
string | The field used to sort the requested object list |
filter |
False |
string | The criteria used to filter the models you are requesting. It should have the following format: {key}{operator}{value}[;{key}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported keys are: "name", "fts". The "fts" filter cannot be used with other filters. |
Example
- name: Execute 'getSubInterfaceList' operation
ftd_configuration:
operation: "getSubInterfaceList"
path_params:
parentId: "{{ parent_id }}"
query_params:
offset: "{{ offset }}"
limit: "{{ limit }}"
sort: "{{ sort }}"
filter: "{{ filter }}"