Get Deployment Settings
Fetches the global configuration settings based on the platform instance type and its supported form factors. Either form_factor or ssp_type must be provided, ssp_type parameter represents the platform instance type.
For MEDIUM form factor:
- min_worker_count: 2
- max_worker_count: 2
- Note: Medium supports exactly 2 workers. Use Large form factor for 4+ workers
For LARGE form factor:
- min_worker_count: 4
- max_worker_count: 13
For EXTRA_LARGE form factor:
- min_worker_count: 8
- max_worker_count: 17
- Note: For high-scale deployments with all features
For instance type parameter:
- AVI_OPERATIONS: AVI Operations deployment (form_factor is SMALL, worker_count: 2)
- ATP: Advanced Threat Protection (requires form_factor parameter)
IP Pool Count Calculation: The API returns minimum IP pool counts (min_node_ip_pool_count and min_service_ip_pool_count) based on the form factor and worker count.
For variable worker count form factors (Medium, Large, Extra-Large):
- worker_count parameter can override the default (must be within valid range)
- If not provided, min_worker_nodes from the form factor spec is used
For fixed worker count instance types (LICENSING, AVI_OPERATIONS):
- worker_count parameter is ignored
- Always uses min_worker_nodes from the deployment spec
Node IP Pool (all deployments): 2 + controller_count + worker_count (1 for VIP + 1 for rolling upgrade + all node IPs)
Service IP Pool (varies by deployment type):
- LICENSING/AVI_OPERATIONS: 3 IPs (1 Contour + 1 kafka-external + 1 kafka broker, no scaleout)
- Medium: 5 IPs (1 Contour + 1 kafka-external + 3 kafka brokers hardcoded)
- Large/Extra-Large: 3 + ceil(worker_count/2) (1 Contour + 1 kafka-external + 1 kafka broker + extra brokers for Kafka cluster)
The form factor for which global settings are being requested. Either form_factor or ssp_type must be provided. Required when ssp_type is ATP.
LARGEThe number of worker nodes to use for IP pool calculation. Only applicable for variable worker count form factors (Medium, Large, Extra-Large). Must be within the valid range [min_worker_nodes, max_worker_nodes] for the form factor. If not provided, min_worker_nodes from the form factor spec is used. Ignored for fixed worker count deployments (LICENSING, AVI_OPERATIONS).
4The platform instance type. Either form_factor or instance_type must be provided.
- AVI_OPERATIONS: AVI Operations deployment (form_factor is SMALL)
- ATP: Advanced Threat Protection (requires form_factor parameter)
ATPSecop global settings retrieved successfully
{
"max_controller_node": 0,
"min_controller_node": 0,
"max_worker_node": 0,
"min_worker_node": 0,
"min_node_ip_pool_count": 0,
"min_service_ip_pool_count": 0
}This is the max number of controller nodes supported.
This is the minimum number of controller nodes supported.
This is the max number of worker nodes supported.
This is the minimum number of worker nodes supported.
The minimum number of IPs required in the Node IP Pool. Calculated as: 2 (1 for VIP + 1 for rolling upgrade) + controller_count + worker_count. Uses min_worker_nodes if worker_count query parameter is not provided.
The minimum number of IPs required in the Service IP Pool. Calculation varies by deployment:
- Licensing/AVI Operations/Evaluation: 3 IPs (1 Contour + 1 kafka-external + 1 kafka broker)
- Medium: 5 IPs (1 Contour + 1 kafka-external + 3 kafka brokers hardcoded)
- Large/Extra-Large: 3 + ceil(worker_count/2) for extra kafka brokers Uses min_worker_nodes if worker_count query parameter is not provided.
Bad request. Either form_factor or ssp_type must be provided. If ssp_type=ATP is provided, form_factor is required.
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
An error occurred while fetching settings.
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -H 'Authorization: <value>' https://{api_host}/sspi/settings