Configuration parameters

Mirroring instance parameters

Table 1. Mirroring instance parameter descriptions
Parameter Description Values
Name Specifies the name of the mirroring instance. String
Labels Specifies the labels to apply to the mirror object. Optional
Description Describes this mirroring instance. Optional
Active Indicates whether the mirroring instance is active.
Automatic deployment Specifies whether a mirroring instance is automatically deployed as soon as it is created.
Source Group Specifies one or more sources previously configured sources for the mirroring instance. For more information, see Mirror source groups.
Destination Specifies a previously configured destination for the mirroring instance. For more information, see Mirror destinations.

Mirror source group settings

Table 2. Mirror source parameter descriptions
Field Name Description Values
Name Specifies the name of the source group.
Labels Specifies the labels to assign to the source object. Name of an existing label
Description Provide a description for this source group. String
Source Group Type Specifies whether the sources of the mirror are interfaces or sub-interfaces. Interface or Sub - Interface
Node Selection Method Specifies whether you want to select the node by node name, by node label, or if you prefer not to specify a node by name or label and instead choose interfaces or sub-interfaces by label only. Node, Node Label, or Not Applicable
Nodes If node selection is by node name, specifies a node from which to select interfaces or sub-interfaces.
Interface Selection Method If the source group type is interface, and the Node Selection Method parameter is set to:
  • Node, this parameter is set to Interface
  • Node Label, this parameter is set to Interface Label
This parameter cannot be modified.
Interfaces Specifies one or more interfaces by interface name. If you selected a node, you can only select interfaces from that node. If you select multiple nodes, only the common interfaces among them are displayed for selection.
Node Labels Specifies a node label. If you specify a node label, all nodes that match the selected label are used as mirror sources.
Interface Labels If the node selection method is by label, specifies an interface label to filter the interfaces to use as source.
  • If the Node Selection Method parameter is set to Not Applicable, the system selects interfaces that match the interface label from any node.
  • If you specified a node label, the system selects interfaces on the specified node that match the label.
Sub-Interfaces If the source group type is sub-interface, specifies one or more sub-interfaces by interface name. If you selected a node, you can only select sub-interfaces from that node.
Sub-Interface Labels Specifies a sub-interface label. If you do not specify a node label (by setting the Node Selection Method parameter to Not Applicable), the system selects any sub-interface that matches the sub-interface label across any node. If you specify a node label, the system selects sub-interfaces that match the sub-interface label on the node.
Traffic Direction Specify the direction of traffic to mirror. Ingress only, Egress only, or Ingress-egress

Mirror destination parameters

Table 3. Mirror destination parameter descriptions
Field Name Description Values
Destination Name Specifies the name of the destination group object.
Description Provides a description for the mirror destination.
Labels Specifies the labels to assign to this mirror destination.
Destination Type Specifies whether this mirror destination local or remote. Local or Remote
Interface If the destination is local, specifies the interface.
VLAN ID If the destination is local, specifies the VLAN ID.
Destination IP If the destination is remote, specifies the IP address of the destination. IPv4 notation
Source IP Specifies the source IP address; if no address is provided, the system IP address is used.

This setting is required for unmanaged nodes.

IPv4 notation
Encapsulation Specifies the encapsulation method. The system supports L2oGRE encapsulation only. You cannot set this parameter.