Try SpotterManage Flow Points on Ciena SAOS 10 devices
Authors: Jeff Groom (@jgroom33)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install ciena.saos10:==1.7.0
collections:
- name: ciena.saos10
version: 1.7.0This module provides declarative management of a flow point on Ciena SAOS 10 devices.
# Using merged
- name: Configure flow point
ciena.saos10.saos10_fps:
config:
- name: fp1
fd-name: foo
logical-port: 1
state: merged
# Using deleted
- name: delete flow point
ciena.saos10.saos10_fps:
config:
- name: fp1
state: deleted
state:
choices:
- merged
- deleted
default: merged
description: The state of the configuration after module completion.
type: str
config:
description: A list of all mef-fp configuration entries.
elements: dict
suboptions:
admin_state:
choices:
- enabled
- disabled
description: Enable/disable the admin state.
required: false
type: str
classifier_list:
description: List of classifier templates referenced by flow-point to define their
incoming classification.
type: str
classifier_list_precedence:
description: A precedence value for the flow-point. Lower values take precedence
over higher values.
required: false
type: int
color:
choices:
- green
- yellow
- red
description: An internal label assigned to frame defining the treatment of a frame
as it switches through the device.
required: false
type: str
cos:
description: An internal label defining the baseline for Class-Of-Service treatment
of a frame as it switches through the device.
required: false
type: int
cos_to_frame_map:
description: A mapping resolving an internal color and cos to frame pcp+dei, dscp,
mpls-tc.
required: false
type: str
description:
description: A editable string used to describe this entry.
required: false
type: str
egress_l2_transform:
description: Egress L2-transform configured on this flow-point.
elements: dict
suboptions:
egress_name:
description: Need a key for this list. It cannot be a choice of several objects
but objects that will always be specified.
required: false
type: str
untagged_dei:
choices:
- enabled
- disabled
description: This enables/disables drop eligibility indicator to indicate
untagged frames eligible to be dropped in the presence of congestion.
required: false
type: str
untagged_pcp:
choices:
- pcp-0
- pcp-1
- pcp-2
- pcp-3
- pcp-4
- pcp-5
- pcp-6
- pcp-7
- map
description: This configures the chosen priority code point which can be used
to prioritize different classes of traffic.
required: false
type: str
untagged_tpid:
choices:
- tpid-8100
- tpid-88a8
- tpid-9100
description: The Tag protocol identifier to be added to an untagged frame
.
required: false
type: str
untagged_vid:
description: This configures the untagged vlan identifier .
required: false
type: int
vlan_stack:
description: This configures VLAN stack on the flow-point.
elements: dict
suboptions:
no_op:
description: No Operation chosen for swapping vlan identifier.
required: false
type: str
pop_type:
description: This removes the outermost tag of the frame.
required: false
type: str
push_dei:
choices:
- enabled
- disabled
description: This enables/disables pushing drop eligibility indicator
to indicate frames eligible to be dropped in the presence of congestion.
required: false
type: str
push_pcp:
choices:
- pcp-0
- pcp-1
- pcp-2
- pcp-3
- pcp-4
- pcp-5
- pcp-6
- pcp-7
- map
description: This chooses how a priority code point (PCP) is determined
on a vlan tag being pushed onto a frame (pcp-value/map). The PCP can
be used to prioritize different classes of traffic.
required: false
type: str
push_tpid:
choices:
- tpid-8100
- tpid-88a8
- tpid-9100
description: This pushes the chosen tag-protocol-identifier in the frame
required: false
type: str
push_vid:
description: This pushes configured VLAN id to the frame.
required: true
type: int
stamp_dei:
choices:
- no-op
- enabled
- disabled
description: Enables/Disables swapping the Drop eligible indicator in
frame .
required: false
type: str
stamp_pcp:
choices:
- pcp-0
- pcp-1
- pcp-2
- pcp-3
- pcp-4
- pcp-5
- pcp-6
- pcp-7
- no-op
- map
description: This swaps the existing Priority code point in frame with
the chosen one .
required: false
type: str
stamp_tpid:
choices:
- no-op
- tpid-8100
- tpid-88a8
- tpid-9100
description: This swaps the existing Tag protocol identifier in frame
with the chosen one .
required: false
type: str
stamp_vid_value:
description: The vlan identifier that is used for swapping.
required: false
type: int
tag:
description: Dependent on the xform operation, the tag numbers are stamp
=> '1' represents outermost tag, '2' next outermost (next inner) pop
=> '1' represents pop outermost, '2' represents pop outermost, (always
pop from outer) push => '1' represents push outermost, '2' represents
push outermost (always push to outer)
required: false
type: int
type: list
type: list
egress_l3_mapped:
description: For an egress-l3-transform, map internal-cos and internal-color to
dscp based on a cos-to-frame-map.
required: false
type: str
egress_remark_dscp_value:
description: Remark the egress L2-Switched packet with the DSCP value.
required: false
type: int
fd_name:
description: The forwarding domain that the flow-point is attached to.
required: false
type: str
flood_containment_profile:
description: Reference to a Flood Containment Profile definition.
required: false
type: str
frame_to_cos_map:
description: A mapping resolving an incoming frame to internal Color and Cos.
required: false
type: str
ingress_l2_transform:
description: Ingress L2-transform configured on this flow-point.
elements: dict
suboptions:
ingress_name:
description: Need a key for this list. It cannot be a choice of several objects
but objects that will always be specified.
required: false
type: str
untagged_dei:
choices:
- enabled
- disabled
description: This enables/disables drop eligibility indicator to indicate
untagged frames eligible to be dropped in the presence of congestion.
required: false
type: str
untagged_pcp:
choices:
- pcp-0
- pcp-1
- pcp-2
- pcp-3
- pcp-4
- pcp-5
- pcp-6
- pcp-7
- map
description: This configures the chosen priority code point which can be used
to prioritize different classes of traffic.
required: false
type: str
untagged_tpid:
choices:
- tpid-8100
- tpid-88a8
- tpid-9100
description: The Tag protocol identifier to be added to an untagged frame
.
required: false
type: str
untagged_vid:
description: This configures the untagged vlan identifier .
required: false
type: int
vlan_stack:
description: This configures VLAN stack on the flow-point.
elements: dict
suboptions:
no_op:
description: No Operation chosen for swapping vlan identifier.
required: false
type: str
pop_type:
description: This removes the outermost tag of the frame.
required: false
type: str
push_dei:
choices:
- enabled
- disabled
description: This enables/disables pushing drop eligibility indicator
to indicate frames eligible to be dropped in the presence of congestion.
required: false
type: str
push_pcp:
choices:
- pcp-0
- pcp-1
- pcp-2
- pcp-3
- pcp-4
- pcp-5
- pcp-6
- pcp-7
- map
description: This chooses how a priority code point (PCP) is determined
on a vlan tag being pushed onto a frame (pcp-value/map). The PCP can
be used to prioritize different classes of traffic.
required: false
type: str
push_tpid:
choices:
- tpid-8100
- tpid-88a8
- tpid-9100
description: This pushes the chosen tag-protocol-identifier in the frame
required: false
type: str
push_vid:
description: This pushes configured VLAN id to the frame.
required: true
type: int
stamp_dei:
choices:
- no-op
- enabled
- disabled
description: Enables/Disables swapping the Drop eligible indicator in
frame .
required: false
type: str
stamp_pcp:
choices:
- pcp-0
- pcp-1
- pcp-2
- pcp-3
- pcp-4
- pcp-5
- pcp-6
- pcp-7
- no-op
- map
description: This swaps the existing Priority code point in frame with
the chosen one .
required: false
type: str
stamp_tpid:
choices:
- no-op
- tpid-8100
- tpid-88a8
- tpid-9100
description: This swaps the existing Tag protocol identifier in frame
with the chosen one .
required: false
type: str
stamp_vid_value:
description: The vlan identifier that is used for swapping.
required: false
type: int
tag:
description: Dependent on the xform operation, the tag numbers are stamp
=> '1' represents outermost tag, '2' next outermost (next inner) pop
=> '1' represents pop outermost, '2' represents pop outermost, (always
pop from outer) push => '1' represents push outermost, '2' represents
push outermost (always push to outer)
required: false
type: int
type: list
type: list
ingress_l3_mapped:
description: For an ingress-l3-transform, map internal-cos and internal-color
to dscp based on a cos-to-frame-map.
required: false
type: str
ingress_remark_dscp_value:
description: Remark the ingress L2-Switched packet with the DSCP value.
required: false
type: int
logical_port:
description: The logical-port associated with the flow-point.
required: false
type: str
mac_learning:
choices:
- enabled
- disabled
description: Enable/disable the MAC learning of flow-point.
required: false
type: str
map_policy:
choices:
- outer-tag
- inner-tag
- mpls-tc
- dscp
- dscp-mpls-tc
description: The fields of frame to map to internal cos and color.
required: false
type: str
meter_profile:
description: A reference to a Meter Profile.
required: false
type: str
mpls_pw:
description: The type of flow-point is MPLS pseudowire.
required: false
type: str
mtu_size:
description: This object indicates the configured EVC maximum service frame format
size. It must be less than or equal to the max-mtu-size. Vendors may choose
to go beyond this limit.
required: false
type: int
name:
description: This object indicates the flow point identifier. The identifier is
a text string that is used to identify a flow point. Unique string values are
chosen to uniquely identify the flow point. Octet values of 0x00 through 0x1f
are illegal. MEF 26.1 restricts the maximum size identifiers to 45 octets.
required: false
type: str
normalized_vid:
description: Used to represent normalized-vid values for EVPN FXC, e.g. MPLS label
+ vid lookup. The tag number represents the position of the normalized-vid.
tag '1' represents outer most tag, tag '2' next outer most, etc. Note that the
normalized-vid is used in conjunction with an ingress-l2-transform of the same
flow-point. That is, an ingress-l2-xform operation of push/stamp is generally
used to ensure that the frame contains the normalized-vid in flow-point to EVPN
service-tunnel direction. In the case of the ingress-l2-transform stamp operation;
- ingress-l2-transform stamp tag 1 (outer) matches normalized-vid tag 1 (outer).
- ingress-l2-transform stamp tag 2 (next outer) matches normalized-vid tag 2
(next outer (aka inner)). In the case of the ingress-l2-transform push operation;
- ingress-l2-transform push tag 1 (outer most) matches normalized-vid tag 1
(outer), when 1 tag is being pushed via the ingress-l2-transform. - ingress-l2-transform
push tag 2 (next outer most) matches normalized-vid tag 1 (outer), when 2 tags
are being pushed via the ingress-l2-transform. - ingress-l2-transform push tag
1 (outer most) matches normalized-vid tag 2 (next outer (aka inner)), when 2
tags are being pushed via the ingress-l2-transform.
elements: dict
suboptions:
tag:
description: The tag number represents the position of the normalized-vid.
'1' represents outer most tag, '2' next outer most, etc. Note that the normalized-vid
is used in conjunction with an ingress-l2-transform of the same flow-point.
That is, an ingress-l2-xform operation of push/stamp is generally used to
ensure that the frame contains the normalized-vid in flow-point to EVPN
service-tunnel direction. In the case of the ingress-l2-transform stamp
operation; - ingress-l2-transform stamp tag 1 (outer) matches normalized-vid
tag 1 (outer). - ingress-l2-transform stamp tag 2 (next outer) matches normalized-vid
tag 2 (next outer (aka inner)). In the case of the ingress-l2-transform
push operation; - ingress-l2-transform push tag 1 (outer most) matches normalized-vid
tag 1 (outer), when 1 tag is being pushed via the ingress-l2-transform.
- ingress-l2-transform push tag 2 (next outer most) matches normalized-vid
tag 1 (outer), when 2 tags are being pushed via the ingress-l2-transform.
- ingress-l2-transform push tag 1 (outer most) matches normalized-vid tag
2 (next outer (aka inner)), when 2 tags are being pushed via the ingress-l2-transform.
required: false
type: int
vlan_id:
description: No description available
required: false
type: int
type: list
other:
description: A flow-point with no specific type
required: false
type: str
pfg_group:
choices:
- leaf
- root
- dynamic
- mesh
- spoke
- group-A
- group-B
- group-C
- group-D
description: The Private-Forwarding-Group that the flow-point belongs to for the
scope of a Private-Forwarding-Group-Profile. Can be leaf/root for a PFG-profile
with PFG-type of leaf-and-root or spokemesh-and-leafroot. Can be mesh/spoke
for a PFG-profile with PFG-type of spoke-and-mesh or spokemesh-and-leafroot.
Can be groupA/B/C/D for a PFG-profile with PFG-type of pfg-groups. Can be leaf/root/dynamic
for a PFG-profile with PFG-type dynamic-leaf-and-root
required: false
type: str
queue_group_instance:
description: A reference to a Queue Group Instance.
required: false
type: str
stats_collection:
choices:
- 'on'
- 'off'
description: Determines whether stats collection will be turned on or not for
a flow-point
required: false
type: str
svlan:
description: A flow-point of type q-in-q, svlan is outer vlan tag.
required: false
type: int
uni:
description: The type of flow-point is uni-port.
required: false
type: str
type: list
after:
description: The resulting configuration model invocation.
returned: when changed
sample: "The configuration returned will always be in the same format\n of the parameters\
\ above.\n"
type: dict
before:
description: The configuration prior to the model invocation.
returned: always
sample: "The configuration returned will always be in the same format\n of the parameters\
\ above.\n"
type: dict
xml:
description: The set of xml commands pushed to the remote device.
returned: always
sample:
- <system xmlns="http://openconfig.net/yang/system"><config><hostname>foo</hostname></config></system>
type: list