portchannelsUpdatePortChannel
Modify port channel configurations in Hyperfabric infrastructure, including settings like LACP mode, member ports, speed, and annotations.
Instructions
Update a specific port channel.
To use this tool, pass the resource ID and the fields to update as arguments
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fabricId | Yes | This is a read-only field. The unique identifier of the fabric to which this port channel belongs to. | |
| id | Yes | This is a read-only field. The unique identifier of the port channel. | |
| annotations | No | A list of name-value annotations to store user-defined data including complex data such as JSON associated with the port channel. | |
| description | No | The description is a user-defined field to store notes about the port channel. | |
| enabled | No | The enabled state of the port channel which indicates if the port channel is enabled or disabled. | |
| labels | No | A list of user-defined labels that can be used for grouping and filtering port channels. | |
| lacpMode | No | LacpMode defines an enumeration of LACP modes. | LACP_ACTIVE |
| maxSpeed | No | The maximum speed of the port channel (E.g. 100G). | |
| members | No | A set of ports (E.g. Ethernet1_1, Ethernet1_4 etc.) of one or more nodes to be grouped in a LACP bundle. | |
| metadata | No | Metadata defines a map of attributes related to the lifecycle of the object. | |
| minLinks | No | The minimum number of active links needed for the port channel to operate. | |
| mtu | No | The Maximum Transmission Unit (MTU) of the port channel. Default value is 9100. The MTU value must be between 1500 and 9100. | |
| name | No | The name of the port channel. Name must have a prefix of PortChannel (E.g. PortChannel1). | |
| roles | No | A list of roles of the port channel. The port roles list is mandatory, must contain exactly one role, and it must be "HOST_PORT". | |
| stp | No | The Spanning Tree Protocol (STP) interface configuration for the port. The configuration is only used when a VLAN is deployed on the port. | |
| vlanIds | No | This is a read-only field. A list of VLAN IDs deployed on the port channel. | |
| vnis | No | This is a read-only field. A list of VNIs attached to the port channel. |