Issue with zscaler.zpacloud.zpa_application_segment_info results

[ngf-davef-devops]

Describe the bug

The zscaler.zpacloud.zpa_application_segment_info module does not return the full list of application segments, only a partial list.

When a specific name is given to the module, the success depends on where in the UI that name sits.

Expected behavior

When queried without a specific application segment name, the module should return a full list of results; and when given a specific valid name, it should return the info for that segment.

Current behavior

Running the example code to list all application segments produces a partial list of the current segments but the results appear to be limited to items found on the first page of the UI.

Running the example code with the name of an application segment found on the first page of the UI results in success, and displays the expected result. If the name of the application segment is found on other pages (in our tenant, we have three pages of application segments), then the module fails and specifies what it considers to be valid names, which only appear on page one of the UI.

Possible solution

Looking through the previous issues, I see issue #69, which appears to be similar in nature?

Steps to reproduce

1. Install prerequisites and collection as described
2. Configure API credentials as required
3. Run example code below to receive a partial list of application segments:

- name: Retrieve Details of All Application Segments  
  zscaler.zpacloud.zpa_application_segment_info:  
    provider: "{{ zpa_cloud }}"

4. Run the example code below to fail / succeed depending on where in the UI the application segment name falls

- name: Retrieve Details of a Specific Application Segments by Name  
    zscaler.zpacloud.zpa_application_segment_info:  
      provider: "{{ zpa_cloud }}"  
      name: "Example Application Segment"  
    register: app_segment_info  
  
- name: App Connector Groups by Name  
   ansible.builtin.debug:  
     msg: "{{ app_segment_info }}"

Context

Unable to use the Ansible collection to manage ZPA. We'd prefer to be able to integrate our ZPA management activities into our ansible workflow, rather than spawning separate toolsets.

Your Environment

• Collection: 2.0.6
• Python: 3.12.3
• Ansible: core 2.18.6
• Zscaler SDK Python Library: 1.6.0

[willguibr]

@ngf-davef-devops Please define " full list of application segments".
How many applications segments are you referring to and is there an error?

Zscaler DevRel

[ngf-davef-devops]

We have 53 application segments configured... they are shown in the UI with 20 segments per page, so we have 3 populated pages.

If I run the code to list all segments ( step 3 above ), it lists 20 segments (the contents of page 1) with all their config.

If I run the code to show the details of one of the specific segments on page 1 ( step 4 above ), it correctly returns the configuration.

If I adjust the code to show one of the segments that is on page 2 or page 3 ( step 4 above ), it displays an error (redacted content below):
fatal: [localhost]: FAILED! => {"changed": false, "msg": "Application Segment '<xyz>' not found. Available: [ <Application segments 1 - 20 from page 1 are listed here> ]"}

[ngf-davef-devops]

Another follow up on this, if I switch my playbook to use the Application Segment ID, instead of the name, it will return single Application Segment data as expected.

So it appears the issue is related to the code that retrieves the full list of application segment names.

[willguibr]

Upgrade to v.2.0.7

Zscaler DevRel

[ngf-davef-devops]

Confirmed as resolved, thanks.

EDIT: Interesting to note, if I return the configuration of an application segment using its ID, the returned value is in a Dictionary called 'groups', however if I use the NAME then the dictionary object returned is 'app_segment". The resulting JSON queries need to differ depending on the method being used.

Not sure if this is intentional.