Try SpotterManage Forwarding Domains 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 forwarding domain on Ciena SAOS 10 devices.
# Using merged
- name: Configure forwarding domain
ciena.saos10.saos10_fds:
config:
- name: remote-fd
mode: vpls
initiate-l2-transform:
vlan-stack:
- tag: 1
push-tpid: tpid-8100
push-pcp: map
push-vid: 127
state: merged
# Using deleted
- name: Delete forwading domain
ciena.saos10.saos10_fds:
config:
- name: remote-fd
state: deleted
state:
choices:
- merged
- deleted
default: merged
description: The state of the configuration after module completion.
type: str
config:
description: The list of configured forwarding domains on the device.
elements: dict
suboptions:
color:
choices:
- green
- yellow
- red
description: For an L2-frame that is initiated/injected via this forwarding domain,
this specifies the fixed color value to use when when the policy is fixed.
required: false
type: str
cos:
description: For an L2-frame that is initiated/injected via this forwarding domain,
this specifies the fixed cos value to use when when the policy is fixed.
required: false
type: int
cos_queue_map:
description: Reference to queue-map for hierarchical shaping/scheduling.
required: false
type: str
description:
description: This is string used to describe the Forwarding Domain.
required: false
type: str
flood_containment_profile:
description: Reference to a Flood Containment Profile definition.
required: false
type: str
initiate_cos_to_frame_map:
description: For an L2-frame that is initiated/injected via this forwarding domain,
this specifies the cos-to-frame map to use for a cos-to-frame map policy of
'mapped' from the initiate-l2-transform config.
required: false
type: str
initiate_frame_to_cos_map:
description: For an L2-frame that is initiated/injected via this forwarding domain,
this specifies the frame-to-cos map to use for an initiate frame-to-cos map
policy of 'mapped'.
required: false
type: str
initiate_frame_to_cos_map_policy:
choices:
- outer-tag
- inner-tag
- mpls-tc
- dscp
description: For an L2-frame that is initiated/injected via this forwarding domain,
this specifies the frame-to-cos-map sub-policy to use when when the policy is
mapped.
required: false
type: str
initiate_l2_transform:
description: For an L2-frame that is initiated/injected via this forwarding domain,
this specifies the l2-transform to be applied to the frame. e.g. an L3-frame
injected via this forwarding domain to L2 datapath.
suboptions:
vlan_stack:
description: For an L2-frame that is initiated/injected via this forwarding
domain, this specifies the VLAN related l2-transform to be applied to the
frame.
elements: dict
suboptions:
push_dei:
choices:
- enabled
- disabled
description: Represents the DEI value of the vlan tag for the tag being
pushed.
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: Represents the PCP value of the vlan tag for the tag being
pushed. When the PCP value is mapped using a cos-to-frame-map, 'map'
is specified.
required: false
type: str
push_tpid:
choices:
- tpid-8100
- tpid-88a8
- tpid-9100
description: Represents the TPID value of the vlan tag for the tag being
pushed
required: false
type: str
push_vid:
description: Represents the VID value of the vlan tag for the tag being
pushed
required: true
type: int
tag:
description: Dependent on the transform operation, the tag numbers are
push => '1' represents push outermost, '2' represents push outermost
(always push to outer)
required: false
type: int
type: list
type: dict
l2cp_profile:
description: Reference to a Layer 2 Control Protocol Tunneling Profile.
required: false
type: str
mac_learning:
choices:
- enabled
- disabled
description: Enable/disable MAC learning for this forwarding-domain.
required: false
type: str
mode:
choices:
- vlan
- vpls
- vpws
- fxc
- tdm-vpls
- tdm-vpws
- evpn-vpws
- evpn-vpls
description: Forwarding mode of the forwarding-domain
required: false
type: str
name:
description: An administratively assigned string, which may be used to identify
the forwarding domain.
required: false
type: str
pfg_profile:
description: Reference to a Private Forwarding Group Profile.
required: false
type: str
queue_group_indirection:
description: Reference to queue-group-indirection for hierarchical shaping/scheduling.
required: false
type: str
vlan_id:
description: The id of VLAN associated with forwarding-domain.
required: false
type: int
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