F5Networks / f5-ansible-f5os

Collection for managing F5OS based devices
2 stars 1 forks source link

f5os_lldp_config documentation not clear #15

Open RemcoAA opened 2 days ago

RemcoAA commented 2 days ago

Is your feature request related to a problem? Please describe.

The documentation is not clear on how to add multiple interfaces in the configuration. The documentation states it need to be a dictionary but it is unclear which format is expected for multiple interfaces. The example also has unsupported parameters (max_core_size, exclude_cores) and for interfaces the parameter is enabled and enable.

Describe the solution you'd like

Update the documentation with correct examples and an example showing multiple interfaces.

Describe alternatives you've considered

n/a

Additional context

n/a

pgouband commented 2 days ago

Hi,

Thanks for reporting. Added to the backlog and internal tracking ID for this request is: INFRAANO-1614.

RemcoAA commented 2 days ago

@pgouband , thanks for picking this up. Could you already share how multiple interfaces should be added?

pgouband commented 13 hours ago

Hi @RemcoAA,

Only one interface can be added or modified by this module and it's working as the webui and API so module is working as expected. Documentation will be updated thanks to your feedback.

// Create LLDP
f5os_lldp_config:
    enabled: true
    system_name: "test"
    system_description: "Test Description"
    tx_interval: 31
    tx_hold: 42
    reinitiate_delay: 23
    max_neighbors_per_port: 15
    tx_delay: 22
    interfaces:
      name: 1.0
      enabled: true
      tlv_advertisement_state: "txonly"
      tlv_map: "chassis-id port-id ttl mfs"
    state: present

// Update Interface
f5os_lldp_config:
    enabled: true
    system_name: "test"
    system_description: "Test Description"
    tx_interval: 31
    tx_hold: 42
    reinitiate_delay: 24
    max_neighbors_per_port: 15
    tx_delay: 22
    interfaces:
      name: 1.0
      enabled: false
      tlv_advertisement_state: "rxonly"
      tlv_map: "chassis-id port-id ttl"
    state: present

 // Add Interface
 f5os_lldp_config:
    enabled: true
    system_name: "test"
    system_description: "Test Description"
    tx_interval: 31
    tx_hold: 42
    reinitiate_delay: 24
    max_neighbors_per_port: 15
    tx_delay: 22
    interfaces:
      name: 2/1.0
      enabled: false
      tlv_advertisement_state: "rxonly"
      tlv_map: "chassis-id port-id ttl"
    state: present
RemcoAA commented 13 hours ago

Hi, then the label "interfaces" is confusing and should be relabeled to "interface"

pgouband commented 11 hours ago

Hi @RemcoAA,

We are reviewing our options and we will update the issue.