breakoutinterface
The breakoutinterface operation handles configuration related to BreakoutInterface model.
Description
This API call is not allowed on the standby unit in an HA pair.
Data Parameters
| Parameter | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| breakoutInterface | True | object | Allowed types are: [PhysicalInterface] |
|||
| interfaces | False | [object] | A read-only field which will return a list of split interfaces after a breakout has occured. Field level constraints: size must be between 0 and 4 (inclusive). (Note: Additional constraints might exist) Allowed types are: [PhysicalInterface] |
|||
| id | False | string | A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
| type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. | |||
Example
- name: Execute 'breakoutinterface' operation
ftd_configuration:
operation: "breakoutinterface"
data:
breakoutInterface: "{{ breakout_interface }}"
interfaces: "{{ interfaces }}"
id: "{{ id }}"
type: "{{ type }}"