Ethernet link¶
Table with one row for each element of the type: 'Ethernet link'.
Columns¶
| Name | Description |
|---|---|
| A | Origin node |
| B | Destination node |
| Description | A user-defined text description (potentially long) that can be assigned to this element |
| Attributes | User-defined attributes associated to this element |
| Hit design rule | The design rule matching this element. |
| CEP B | TAPI connection-edge-point in the link destination |
| SRGs | The Shared Risk Groups (SRGs) this element belongs to: the SRGs that mandate the shutdown (set in failure state) of this element |
| NEP A | TAPI node-edge-point in the link origin |
| CEP A | TAPI connection-edge-point in the link origin |
| TAPI uuid | TAPI global uuid json object |
| NEP B | TAPI node-edge-point in the link destination |
| Name | A user-defined name (typically short) that can be assigned to this element |
| Identifier | A unique identifier set to the element, and never changed |
| Length (km) | The length in km of this element |
| Latency (ms) | The latency in miliseconds added to the traffic traversing this element |
| IP Port (B) | IP Hardware port in B attached in this Ethernet link, if not attached to an Ethernet switch |
| Traversing IP Links | IP links traversing this Ethernet link |
| External links | Indicates if this element has one or more user-defined external URLs associated to it. If so, when the user clicks this cell, and selects the URL (if more than one), a navigator is launched and the URL page is shown. External links are not editable in the GUI, but via API. |
| Tags | User-defined tags associated to this element |
| Current carried traffic (Gbps) | Indicates the current carried traffic in Gbps. |
| TAPI JSON | Full TAPI JSON for this element |
| Intra-node | Indicates if both end nodes are the same or not |
| Bidi pair | If this element is bidirectional, contains its bidirectional pair |
| JSON | An optional JSON content describing this element |
| Nominal rate (Gbps) | Nominal rate in Gbps of the Ethernet port |
| Installed | Indicates if the element is installed. If not installed, the element behaves as if it did not exist, being unable to e.g. handle traffic or reserve any bandwidth |
| IP Port (A) | IP Hardware port in A attached in this Ethernet link, if not attached to an Ethernet switch |
| TAPI Local uuid | TAPI local UUID. This means, local respet to belonging TAPI element |
| Show | Show the element in the canvas, or else hide it |
| Up | Indicates if the element is up (active) or down (failed) |
| Utilization (%) | Indicates the point-to-multipoint utilization (maximum utilization of all attached IP logical ports of the Ethernet link). |
Views¶
| Name | Columns | Description |
|---|---|---|
| Full view | Name, Identifier, Description, ExternalLinks, Show, A, B, Intra-node, BidiPair, Length(km), Latency(ms), HitDesignRule, Up, Installed, Srgs, NominalRate(gbps), CurrentCarriedTraffic(gbps), Utilization(%), IpPort(a), IpPort(b), TraversingIpLinks, Tags, Attributes, Json, NepA, NepB, CepA, CepB, TapiLocalUuid, TapiUuid, TapiJson | This table view corresponds to a view with all the table columns. In some occassions, this may imply an impractically large number of columns for human inspection. |
| TAPI | A, B, Up, NepA, NepB, CepA, CepB, TapiLocalUuid, TapiUuid, TapiJson | Columns associated to TAPI-related info |
| Failure status | A, B, Up, Installed, Srgs | Columns associated to the risks this element belongs to, and its failure status |
| Connectivity | A, B, BidiPair, Up | Columns associated to the element related paths, links, neighbor nodes and alike |
| Design info | A, B, HitDesignRule, Up | Columns associated to design algorithms, or design rules imposed to the network |
| Description & tags & attributes | Name, Identifier, Description, ExternalLinks, A, B, Up, Tags, Attributes, Json | Columns associated to side information like element names, descriptions, user associated tags or attributes |
| KPIs | A, B, Length(km), Latency(ms), Up, Installed | Columns associated to traffic-related KPIs of the multicast flows |
| Default view | Show, A, B, Latency(ms), Up, NominalRate(gbps), CurrentCarriedTraffic(gbps), Utilization(%), IpPort(a), IpPort(b), TraversingIpLinks, Tags | This table view corresponds to a subset of columns selected as representative for a default table view. They typically include the most typical required values |
Table right-click menu¶
- Set for selected elements...: Menu with options for setting values to different parameters of the selected elements
- Value at column 'Name': This option sets the value at column 'Name'
- For selected elements: Set the value at column 'Name' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For all table elements: Set the value at column 'Name' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Value at column 'Identifier': This option sets the value at column 'Identifier'
- For selected elements: Set the value at column 'Identifier' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For all table elements: Set the value at column 'Identifier' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Value at column 'Description': This option sets the value at column 'Description'
- For selected elements: Set the value at column 'Description' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For all table elements: Set the value at column 'Description' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Value at column 'Show': This option sets the value at column 'Show'
- As true:
- For selected elements: Set the value at column 'Show' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For selected elements: Set the value at column 'Show' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- As false:
- For selected elements: Set the value at column 'Show' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For selected elements: Set the value at column 'Show' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Value at column 'Length (km)': This option sets the value at column 'Length (km)'
- For selected elements: Set the value at column 'Length (km)' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For all table elements: Set the value at column 'Length (km)' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Scale link length by a multiplicative factor: This option sets the value at column 'Length (km)'
- For selected elements: Set the value at column 'Length (km)' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For all table elements: Set the value at column 'Length (km)' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Set link length from geographical distance of end nodes: This option sets the value at column 'Length (km)'
- For selected elements: Set the value at column 'Length (km)' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For all table elements: Set the value at column 'Length (km)' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Value at column 'Latency (ms)': This option sets the value at column 'Latency (ms)'
- For selected elements: Set the value at column 'Latency (ms)' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For all table elements: Set the value at column 'Latency (ms)' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Scale latency by a multiplicative factor: This option sets the value at column 'Latency (ms)'
- For selected elements: Set the value at column 'Latency (ms)' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For all table elements: Set the value at column 'Latency (ms)' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Set link latency as proportional to link length: This option sets the value at column 'Latency (ms)'
- For selected elements: Set the value at column 'Latency (ms)' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For all table elements: Set the value at column 'Latency (ms)' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Value at column 'Up': This option sets the value at column 'Up'
- As true:
- For selected elements: Set the value at column 'Up' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For selected elements: Set the value at column 'Up' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- As false:
- For selected elements: Set the value at column 'Up' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For selected elements: Set the value at column 'Up' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Value at column 'Installed': This option sets the value at column 'Installed'
- As true:
- For selected elements: Set the value at column 'Installed' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For selected elements: Set the value at column 'Installed' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- As false:
- For selected elements: Set the value at column 'Installed' for: Selected elements (The elements already selected by the user in the table before calling this action)
- For selected elements: Set the value at column 'Installed' for: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Add new Ethernet link: Adds an Ethernet link to the network design
- Remove: Different remove options
- Selected elements: Remove elements: Selected elements (The elements already selected by the user in the table before calling this action)
- All table elements: Remove elements: All table elements (All the elements in the table, not applying any filter, and not considering any pagination)
- Bidirectional relations: Different options to manage bidirectionality relations between elements
- Remove bidirectional association to selected elements: For all selected elements that are bidirectional, removes such bidirectional association leaving two unidirectional independent elements
- Set bidirectional pair to selected element: For all selected elements that are not currently bidirectional, are arranged into pairs of opposite elements (with opposite end nodes), and are set as bidirectional.
- Tags: Different menu options related to user-defined tags
- Add tag: Adds a user-defined tag to the indicated elements
- Remove tag: Removes a user-defined tag from the indicated elements
- Remove all tags: For all the indicated elements, all their tags are removed
- Add tags to element end nodes: For all the user indicated elements, a user-defined tag is added to both end nodes of the element
- Remove tags from element end nodes: For all the user indicated elements, a user-defined tag is removed from both end nodes of the element
- Attributes: Different menu options related to user-defined attributes
- Add attribute: Adds a user-defined attribute (key-value pair) to all the selected elements. Any attribute with the same key is replaced by the new value.
- Remove attribute: Removes a user-defined attribute (key-value pair) from all the selected elements.
- Remove all attributes: Removes all the user-defined attributes (key-value pair) from the indicated elements.
Form-required interactions¶
IP Autonomous System-Create¶
Form to complete:
- AS name: The name of the new Autonomous System (AS) that will be created.
Network Controller-AddTag¶
Form to complete:
- Tag: The tag string.
- Applicable elements: This selector indicates the elements to which this action is going to be applied. Options:
- Selected elements: The elements already selected by the user in the table before calling this action.
- All table elements: All the elements in the table, not applying any filter, and not considering any pagination.
Network Controller-RemoveTag¶
Form to complete:
- Tag: The tag string.
- Applicable elements: This selector indicates the elements to which this action is going to be applied. Options:
- Selected elements: The elements already selected by the user in the table before calling this action.
- All table elements: All the elements in the table, not applying any filter, and not considering any pagination.
Network Controller-RemoveAllTags¶
Form to complete:
- Applicable elements: This selector indicates the elements to which this action is going to be applied. Options:
- Selected elements: The elements already selected by the user in the table before calling this action.
- All table elements: All the elements in the table, not applying any filter, and not considering any pagination.
Ethernet link-AddTagToEndNodes¶
Form to complete:
- Tag: The tag string.
- Applicable elements: This selector indicates the elements to which this action is going to be applied. Options:
- Selected elements: The elements already selected by the user in the table before calling this action.
- All table elements: All the elements in the table, not applying any filter, and not considering any pagination.
Ethernet link-RemoveTagFromEndNodes¶
Form to complete:
- Tag: The tag string.
- Applicable elements: This selector indicates the elements to which this action is going to be applied. Options:
- Selected elements: The elements already selected by the user in the table before calling this action.
- All table elements: All the elements in the table, not applying any filter, and not considering any pagination.
Network Controller-AddAttribute¶
Form to complete:
- Key: The attributes key, or name.
- Value: The attribute value, to associate to the attribute name.
- Applicable elements: This selector indicates the elements to which this action is going to be applied. Options:
- Selected elements: The elements already selected by the user in the table before calling this action.
- All table elements: All the elements in the table, not applying any filter, and not considering any pagination.
Network Controller-RemoveAttribute¶
Form to complete:
- Key: The attributes key, or name.
- Applicable elements: This selector indicates the elements to which this action is going to be applied. Options:
- Selected elements: The elements already selected by the user in the table before calling this action.
- All table elements: All the elements in the table, not applying any filter, and not considering any pagination.
Network Controller-RemoveAllAttributes¶
Form to complete:
- Applicable elements: This selector indicates the elements to which this action is going to be applied. Options:
- Selected elements: The elements already selected by the user in the table before calling this action.
- All table elements: All the elements in the table, not applying any filter, and not considering any pagination.