For more information regarding the security incident at F5, the actions we are taking to address it, and our ongoing efforts to protect our customers, click here.

Forum Discussion

nickamon's avatar
nickamon
Icon for Nimbostratus rankNimbostratus
Dec 13, 2023

iControl Rest Create Portal Access Resource with Caption

Hi, I am using the iControl REST API to create a portal-access resource but there doesn't seem to a attribute of the resource that allows setting the Caption field in the "Customization Settings for...
devops
Lucas_Thompson's avatar
Lucas_Thompson
Icon for Employee rankEmployee
Dec 13, 2023

The customization system in APM is complicated by the simultaneous support of multiple languages, so you can have a multi-lingual caption depeding on the user's desired language. This multi-language caption information is stored inside an XML file that is linked from the cache-path property (same as all other config objects that refer to files). For example:

apm policy customization-group /Common/webssh-direct_webssh_resource_customization {
cache-path /config/filestore/files_d/Common_d/customization_group_d/:Common:webssh-direct_webssh_resource_customization_118064_2
revision 2
source /Common/standard
type resource-webssh
}

And the associated cache-path file contents:

<?xml version="1.0" encoding="UTF-8"?>
<customization_group name="default_resource_webssh" type="resource_webssh">
<item language="en">
<image></image>
<caption>webssh-direct</caption>
</item>
</customization_group>

You may have to create the file object first (just in the filesystem), then refer to it in the customization group. When doing this kind of thing in TMSH because the resource-item and customization-group are interdependent, you have to create them in a single transaction. I'm not certain if iControl works this same way or requires this transaction treatment.

abrahamf5's avatar
abrahamf5
Icon for Employee rankEmployee
Feb 25, 2025

Here are the step I followed for an automated approach

  1. Create the xml file that contains the customization details
    1. The best way to do this is to create the resource and manually make the modifications you wish to see
    2. Get the path to the xml file from the customization-group object associated with the above policy resource from the appropriate entry in the bigip.conf file (cache-path attribute)
    3. Copy the xml file.
  2. Upload the xml file to the bigip using "/mgmt/shared/file-transfer/uploads/<file_name>" endpoint
  3. When creating (or modifying) the customization-group object for the resource, use the "local-path" attribute to reference the file uploaded to BigIP in the step above
      "local-path" : "/var/config/rest/downloads/<file_name from step 2> "
  4. "Apply Policy changes"