Addition of L4l7 device modules (DCNE-334) #739

shrsr · 2025-04-10T16:03:22Z

This PR contains completed aci_l4l7_device and related modules from #186

akinross · 2025-04-11T11:17:37Z

plugins/modules/aci_l4l7_concrete_device.py

+    aliases: [ concrete_device, concrete_device_name ]
+  vcenter_name:
+    description:
+    - The virtual center name on which the device is hosted in the L4-L7 device cluster.


what is the virtual center referring to? is this VMware VCenter?

Likely because vCenter is a product that solely belongs to VMware?

plugins/modules/aci_l4l7_logical_interface.py

akinross

LGTM

anvitha-jain

LGTM

gmicol

LGTM

lhercot · 2025-04-18T06:54:23Z

plugins/modules/aci_l4l7_concrete_interface.py

+  path_ep:
+    description:
+    - The path to the physical interface.
+    - For single ports, this is the port name, e.g. "eth1/15".
+    - For Port-channels and vPCs, this is the Interface Policy Group name.
+    type: str


I would move path_ep as an alias and have interface as the main attribute and interface_name and interface_policy_group and interface_policy_group_name as additional aliases.

lhercot · 2025-04-18T07:01:18Z

plugins/modules/aci_l4l7_concrete_interface_attach.py

+DOCUMENTATION = r"""
+---
+module: aci_l4l7_concrete_interface_attach
+short_description: Manage L4-L7 Concrete Interface Attach (vns:RsCIfAttN)


Suggested change

short_description: Manage L4-L7 Concrete Interface Attach (vns:RsCIfAttN)

short_description: Manage L4-L7 Concrete Interface Attachment (vns:RsCIfAttN)

lhercot · 2025-04-18T07:03:40Z

plugins/modules/aci_l4l7_device.py

+module: aci_l4l7_device
+short_description: Manage L4-L7 Devices (vns:LDevVip)
+description:
+- Manage Layer 4-7 (L4-L7) Devices.


Suggested change

- Manage Layer 4-7 (L4-L7) Devices.

- Manage Layer 4 to Layer 7 (L4-L7) Devices.

lhercot · 2025-04-18T07:05:25Z

plugins/modules/aci_l4l7_device.py

+    - The APIC defaults to C(single) when unset during creation.
+    type: str
+    choices: [ multi, single ]
+  dev_type:


swap attribute and aliases

lhercot · 2025-04-18T07:05:48Z

plugins/modules/aci_l4l7_device.py

+    type: str
+    choices: [ physical, virtual ]
+    aliases: [ device_type ]
+  func_type:


swap attribute and aliases

lhercot · 2025-04-18T07:08:26Z

plugins/modules/aci_l4l7_device.py

+    dev_type: physical
+    svc_type: adc
+    trunking: false
+    prom_mode: true


Suggested change

prom_mode: true

promiscuous_mode: true

lhercot · 2025-04-18T07:09:07Z

plugins/modules/aci_l4l7_logical_interface.py

+module: aci_l4l7_logical_interface
+short_description: Manage L4-L7 Logical Interface (vns:LIf)
+description:
+- Manage Layer 4-7 (L4-L7) Logical Interfaces.


Suggested change

- Manage Layer 4-7 (L4-L7) Logical Interfaces.

- Manage Layer 4 to Layer 7 (L4-L7) Logical Interfaces.

lhercot · 2025-04-18T07:09:26Z

plugins/modules/aci_l4l7_concrete_interface_attach.py

+module: aci_l4l7_concrete_interface_attach
+short_description: Manage L4-L7 Concrete Interface Attach (vns:RsCIfAttN)
+description:
+- Manage Layer 4-7 (L4-L7) Concrete Interface Attachment to Logical Interfaces.


Suggested change

- Manage Layer 4-7 (L4-L7) Concrete Interface Attachment to Logical Interfaces.

- Manage Layer 4 to Layer 7 (L4-L7) Concrete Interface Attachment to Logical Interfaces.

lhercot · 2025-04-18T07:09:39Z

plugins/modules/aci_l4l7_concrete_interface.py

+module: aci_l4l7_concrete_interface
+short_description: Manage L4-L7 Concrete Interfaces (vns:CIf)
+description:
+- Manage Layer 4-7 (L4-L7) Concrete Interfaces.


Suggested change

- Manage Layer 4-7 (L4-L7) Concrete Interfaces.

- Manage Layer 4 to Layer 7 (L4-L7) Concrete Interfaces.

lhercot · 2025-04-18T07:09:51Z

plugins/modules/aci_l4l7_concrete_device.py

+module: aci_l4l7_concrete_device
+short_description: Manage L4-L7 Concrete Devices (vns:CDev)
+description:
+- Manage Layer 4-7 (L4-L7) Concrete Devices.


Suggested change

- Manage Layer 4-7 (L4-L7) Concrete Devices.

- Manage Layer 4 to Layer 7 (L4-L7) Concrete Devices.

…st file

plugins/modules/aci_l4l7_concrete_device.py

akinross · 2025-04-25T15:01:51Z

plugins/modules/aci_l4l7_concrete_device.py

+  description: More information about the internal APIC class B(vns:CDev)
+  link: https://developer.cisco.com/docs/apic-mim-ref/
+author:
+- Tim Cragg (@timcragg)


your name in modules

akinross · 2025-04-25T15:02:10Z

tests/integration/targets/aci_l4l7_concrete_device/tasks/main.yml

@@ -0,0 +1,196 @@
+# Test code for the ACI modules
+# Copyright: (c) 2025, Tim Cragg (@timcragg)


your name in modules tests

akinross · 2025-04-25T15:02:47Z

plugins/modules/aci_l4l7_concrete_interface_attach.py

+
+DOCUMENTATION = r"""
+---
+module: aci_l4l7_concrete_interface_attach


why not name the module with full name?

Suggested change

module: aci_l4l7_concrete_interface_attach

module: aci_l4l7_concrete_interface_attachment

…s with changed names

… with changed names

sajagana

LGTM!

… with changed names in v3.0.0

gmicol · 2025-05-02T16:14:25Z

plugins/modules/aci_l4l7_concrete_device.py

+seealso:
+- module: aci_l4l7_device


Shouldn't we reference the module for the tenant here as well?

Suggested change

seealso:

- module: aci_l4l7_device

seealso:

- module: aci_tenant

- module: aci_l4l7_device

If so it should be applied it to every module where it was missed

gmicol · 2025-05-02T16:23:12Z

plugins/modules/aci_l4l7_concrete_device.py

+  device:
+    description:
+    - The name of the logical device (vns:lDevVip) the concrete device is attached to.
+    type: str
+    aliases: [ device_name, logical_device_name ]


Is it not better to call it logical_device and add device as an alias? It would be less confusing since we have logical device and concrete device but this is just a suggestion

Suggested change

device:

description:

- The name of the logical device (vns:lDevVip) the concrete device is attached to.

type: str

aliases: [ device_name, logical_device_name ]

logical_device:

description:

- The name of the logical device (vns:lDevVip) the concrete device is attached to.

type: str

aliases: [ device, device_name, logical_device_name ]

If you do make the change, it should be applied to every module where logical device is referenced

gmicol · 2025-05-02T16:27:15Z

plugins/modules/aci_l4l7_device.py

+    description:
+    - The name of the L4-L7 device.
+    type: str
+    aliases: [ device, device_name, logical_device_name ]


Shouldn't we add an extra alias? logical_device?

Suggested change

aliases: [ device, device_name, logical_device_name ]

aliases: [ device, device_name, logical_device, logical_device_name ]

gmicol · 2025-05-02T16:29:27Z

plugins/modules/aci_l4l7_logical_interface.py

+  device:
+    description:
+    - The name of an existing Logical Device.
+    type: str


forgot to add the aliases:

Suggested change

device:

description:

- The name of an existing Logical Device.

type: str

device:

description:

- The name of an existing Logical Device.

type: str

aliases: [ logical_device, device_name, logical_device_name ]

gmicol · 2025-05-02T16:32:09Z

plugins/modules/aci_l4l7_logical_interface.py

+  logical_interface:
+    description:
+    - The name of an existing Logical Interface.
+    type: str


Shouldn't we add a few aliases? like name, logical_interface_name, interface, interface_name, etc...?

gmicol · 2025-05-02T16:33:49Z

plugins/modules/aci_l4l7_concrete_interface_attachment.py

+  device:
+    description:
+    - The name of an existing Logical Device.
+    type: str
+  logical_interface:
+    description:
+    - The name of an existing Logical Interface.
+    type: str
+  concrete_device:
+    description:
+    - The name of an existing Concrete Device.
+    type: str
+  concrete_interface:
+    description:
+    - The name of an existing Concrete Interface.
+    type: str


Shouldn't we add the aliases we have defined for these attributes in their respective referenced modules?

The single alias of name in other modules become the main attribute name in this module. Made changes to others!

…chment

gmicol

LGTM

samiib · 2025-05-09T04:52:58Z

plugins/modules/aci_l4l7_concrete_device.py

+- cisco.aci.aci
+- cisco.aci.annotation
+notes:
+- The I(tenant) and I(device) must exist before using this module in your playbook.


Should this use O for option instead.

Suggested change

- The I(tenant) and I(device) must exist before using this module in your playbook.

- The O(tenant) and O(logical_device) must exist before using this module in your playbook.

This comment was already made by @gmicol in a related PR. In ansible ACI collection we've been using I() for Input in the other modules. I believe that this usage should be consistent within this collection.

samiib · 2025-05-09T10:01:34Z

plugins/modules/aci_l4l7_concrete_interface.py

+- cisco.aci.aci
+- cisco.aci.annotation
+notes:
+- The I(tenant), I(device) and I(concrete_device) must exist before using this module in your playbook.


Suggested change

- The I(tenant), I(device) and I(concrete_device) must exist before using this module in your playbook.

- The O(tenant), O(logical_device) and O(concrete_device) must exist before using this module in your playbook.

Same comment as above

samiib · 2025-05-09T10:04:14Z

plugins/modules/aci_l4l7_concrete_interface_attachment.py

+- cisco.aci.aci
+- cisco.aci.annotation
+notes:
+- The I(tenant), I(device), I(logical_interface) and I(concrete_device) must exist before using this module in your playbook.


Suggested change

- The I(tenant), I(device), I(logical_interface) and I(concrete_device) must exist before using this module in your playbook.

- The O(tenant), O(logical_device), O(logical_interface) and O(concrete_device) must exist before using this module in your playbook.

Same comment as above

samiib · 2025-05-09T10:06:04Z

plugins/modules/aci_l4l7_device.py

+- cisco.aci.aci
+- cisco.aci.annotation
+notes:
+- The I(tenant) must exist before using this module in your playbook.


Suggested change

- The I(tenant) must exist before using this module in your playbook.

- The O(tenant) must exist before using this module in your playbook.

Same comment as above

samiib · 2025-05-09T10:07:10Z

plugins/modules/aci_l4l7_logical_interface.py

+- cisco.aci.aci
+- cisco.aci.annotation
+notes:
+- The I(tenant) and I(device) must exist before using this module in your playbook.


Suggested change

- The I(tenant) and I(device) must exist before using this module in your playbook.

- The O(tenant) and O(logical_device) must exist before using this module in your playbook.

Same comment as above

…4l7 device modules

samiib

LGTM

sajagana

LGTM!

akinross

LGTM

anvitha-jain

LGTM

gmicol

LGTM

samiib

LGTM

lhercot

LGTM

shrsr requested review from akinross, anvitha-jain, gmicol, lhercot, sajagana and samiib as code owners April 10, 2025 16:03

shrsr added the jira-sync Sync this issue to Jira label Apr 10, 2025

github-actions bot changed the title ~~Addition of L4l7 device modules~~ Addition of L4l7 device modules (DCNE-334) Apr 10, 2025

akinross requested changes Apr 11, 2025

View reviewed changes

shrsr requested a review from akinross April 11, 2025 17:18

akinross previously approved these changes Apr 14, 2025

View reviewed changes

anvitha-jain previously approved these changes Apr 14, 2025

View reviewed changes

gmicol previously approved these changes Apr 18, 2025

View reviewed changes

lhercot requested changes Apr 18, 2025

View reviewed changes

timcragg and others added 7 commits April 22, 2025 11:28

[minor_change] Addition of module aci_l4l7_device and its test file

5fd5812

[minor_change] Addition of module aci_l4l7_concrete_device and its te…

c57b3e3

…st file

[ignore] Removed aci_ip_sla_monitoring_policy module and its test file

15983a0

[ignore] Addition of concrete device modules and their test files

19da4e0

[ignore] Modified description of attributes in concrete device modules

e1e3b45

[ignore] Modified aci_l4l7_device modules to add appropriate aliases

434f044

[ignore] Added accidentally removed test file

ef3845b

shrsr dismissed stale reviews from gmicol, anvitha-jain, and akinross via ef3845b April 22, 2025 15:50

shrsr force-pushed the l4l7 branch from 5966b2a to ef3845b Compare April 22, 2025 15:50

shrsr added 2 commits April 22, 2025 11:52

[ignore] Modified description in aci_l4l7_concrete_interface_attach

7909d0b

[ignore] Modified required_if in aci_l4l7_device

72b9cdc

shrsr requested review from akinross, anvitha-jain and gmicol April 22, 2025 16:03

akinross requested changes Apr 25, 2025

View reviewed changes

[ignore] Addition of plugin routing in runtime.yml to redirect module…

23e123d

…s with changed names

shrsr requested a review from akinross April 29, 2025 14:58

shrsr added 2 commits April 29, 2025 10:59

[ignore] Addition of empty line in runtime.yml

a040efa

[ignore] Changes to plugin routing in runtime.yml to redirect modules…

86981de

… with changed names

sajagana previously approved these changes Apr 30, 2025

View reviewed changes

[ignore] Changes to plugin routing in runtime.yml to redirect modules…

881fbf0

… with changed names in v3.0.0

shrsr dismissed sajagana’s stale review via 881fbf0 May 1, 2025 15:39

shrsr requested a review from sajagana May 1, 2025 15:39

gmicol requested changes May 2, 2025

View reviewed changes

shrsr added 2 commits May 7, 2025 11:44

[ignore] Made changes to aliases of aci_l4l7 modules

9a70b06

[ignore] Applied black formatting to aci_l4l7_concrete_interface_atta…

0bd3e88

…chment

shrsr requested a review from gmicol May 7, 2025 15:55

gmicol previously approved these changes May 7, 2025

View reviewed changes

samiib requested changes May 9, 2025

View reviewed changes

shrsr requested a review from samiib May 12, 2025 16:07

[ignore] Added namespace and collection to see also note in docs of l…

614c89f

…4l7 device modules

shrsr dismissed gmicol’s stale review via 614c89f May 13, 2025 19:46

shrsr requested a review from gmicol May 13, 2025 19:46

samiib previously approved these changes May 14, 2025

View reviewed changes

[ignore] Changed description of docs in aci_l4l7_device

7223fe7

shrsr dismissed samiib’s stale review via 7223fe7 May 14, 2025 14:03

shrsr requested a review from samiib May 14, 2025 14:03

sajagana approved these changes May 14, 2025

View reviewed changes

akinross approved these changes May 15, 2025

View reviewed changes

anvitha-jain approved these changes May 15, 2025

View reviewed changes

gmicol approved these changes May 19, 2025

View reviewed changes

samiib approved these changes May 21, 2025

View reviewed changes

lhercot approved these changes May 23, 2025

View reviewed changes

lhercot merged commit 8243460 into CiscoDevNet:master May 23, 2025
23 of 24 checks passed

	short_description: Manage L4-L7 Concrete Interface Attach (vns:RsCIfAttN)
	short_description: Manage L4-L7 Concrete Interface Attachment (vns:RsCIfAttN)

	- Manage Layer 4-7 (L4-L7) Devices.
	- Manage Layer 4 to Layer 7 (L4-L7) Devices.

	- Manage Layer 4-7 (L4-L7) Logical Interfaces.
	- Manage Layer 4 to Layer 7 (L4-L7) Logical Interfaces.

	- Manage Layer 4-7 (L4-L7) Concrete Interface Attachment to Logical Interfaces.
	- Manage Layer 4 to Layer 7 (L4-L7) Concrete Interface Attachment to Logical Interfaces.

	- Manage Layer 4-7 (L4-L7) Concrete Devices.
	- Manage Layer 4 to Layer 7 (L4-L7) Concrete Devices.

		@@ -0,0 +1,196 @@
		# Test code for the ACI modules
		# Copyright: (c) 2025, Tim Cragg (@timcragg)

	module: aci_l4l7_concrete_interface_attach
	module: aci_l4l7_concrete_interface_attachment

	aliases: [ device, device_name, logical_device_name ]
	aliases: [ device, device_name, logical_device, logical_device_name ]

	- The I(tenant) and I(device) must exist before using this module in your playbook.
	- The O(tenant) and O(logical_device) must exist before using this module in your playbook.

	- The I(tenant), I(device) and I(concrete_device) must exist before using this module in your playbook.
	- The O(tenant), O(logical_device) and O(concrete_device) must exist before using this module in your playbook.

	- The I(tenant), I(device), I(logical_interface) and I(concrete_device) must exist before using this module in your playbook.
	- The O(tenant), O(logical_device), O(logical_interface) and O(concrete_device) must exist before using this module in your playbook.

	- The I(tenant) must exist before using this module in your playbook.
	- The O(tenant) must exist before using this module in your playbook.

Addition of L4l7 device modules (DCNE-334) #739

Addition of L4l7 device modules (DCNE-334) #739

Uh oh!

Conversation

shrsr commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

akinross left a comment

Choose a reason for hiding this comment

Uh oh!

anvitha-jain left a comment

Choose a reason for hiding this comment

Uh oh!

gmicol left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sajagana left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gmicol left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shrsr commented Apr 10, 2025 •

edited

Loading