Configuration Update Configuration Module
Updates the specified configuration module and/or modifies its network service associations (refs). Example use cases include:
- Create a new firewall rule or modify an existing one
- Create a business policy or modify an existing one
- Configure device settings such as high availability, Cloud VPN, etc.
- (Operator-only) Configure Operator Profile settings such as application maps.
This method requires an _update parameter - an object specifying the module attribute(s) to be updated and their corresponding value(s).
In the cases where it is necessary to modify network service assocations (e.g. when configuring a VPN hub or cloud security provider, adding a network segment to a profile, etc.), the _update payload should consist of the updated module data and refs. For historical reasons, we advise that refs should also be included any time a user means to update a deviceSettings configuration module where partner gateways are configured (regardless of whether or not the user intends to change the partner gateway assignments or the order thereof with that update).
For use cases where it is not necessary to modify network service associations, data should be the only attribute that appears in the _update payload.
Notes and Limitations
- This method does not support partial or patch-like updates on any sub-section of the
dataorrefsobjects. Generally speaking, an update involves retrieving a module, making incremental changes to thedata(and/orrefs, if required), and passing the modifieddata/refsobjects back to the server in their entirety as part of the_updatespec. - Due to a limitation of the Swagger language, the request body schema model that appears below does not reference each of the
dataandrefsschema definitions for the various module types. Those models may however be found in the model reference below (segmentBasedDeviceSettings,firewall,QOS,WAN,controlPlane,imageUpdate,managementPlane,metaData).
Privileges required:
UPDATE ENTERPRISE_PROFILE, or
UPDATE OPERATOR_PROFILE
{
"id": 0,
"configurationModuleId": 0,
"enterpriseId": 0,
"basic": false,
"_update": {
"created": "string",
"effective": "string",
"modified": "string",
"id": 0,
"name": "string",
"type": "string",
"description": "string",
"configurationId": 0,
"enterpriseLogicalId": "string",
"data": {},
"schemaVersion": "string",
"version": "string",
"metadata": {},
"refs": {}
}
}Alias for configurationModuleId
The id of the target configuration module. This parameter, or its alias id, is required.
enterpriseId
basic
Request was successfully processed
"configuration_update_configuration_module_result Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/portal/rest/configuration/updateConfigurationModule