Get Site Profile (v2.0)
POST/v2.0/api/tenants/:tenant_id/bulkconfigurations/sitetemplates/deployments/query
Query and list all the created site profile.
Request
Path Parameters
The tenant ID.
- application/json
Body
Details of the Site Profile to be created
- Array [
- ]
aggregate Aggregate
The aggregate number of site profiles that match the query parameters.
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
Field
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
Operator
QoS application aggregate statistics.
The unit.
The destination page.
The number site profiles; deleted for a time frame.
Group the site profiles for the query.
List the site profiles by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Retrieve information from a field.
List the fields to query.
The total number of query parameters.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- Array [
- ]
- ]
- ]
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
The tenant ID.
Total number.
items BulkConfigPushQueryFilter[]
List by the site profile created date.
List by the site deployment ID.
elements ElementQueryFilter[]
List by the following element details.
Possible values: [ALLOCATE
, CLAIM
, BOUND
, UNBOUND
, DECLAIM
, RETURN
, REVOKE
, RETIRE
, STOCK
, UPGRADE
, REMANUFACTURE
, DEFAULT
, INVALID
]
The values of admin actions that can be performed.
Possible values: [NONE
, HUB
, SPOKE
, PA_WE_BR
, PA_WE_DC
, PA_CONN
]
The allowed roles.
The element ID.
The cluster member ID.
The element is connected. True or False.
Possible values: [DECLAIM
, UPGRADE
, ABORT_UPGRADE
, DEFAULT
, INVALID
, REBIND
, READY
, IN_SERVICE
, REUNBIND
, RENEW_CIC
, ABORT_CELLULARMODULE_FIRMWARE_UPGRADE
, FIPS_AUTO
, NON_FIPS_AUTO
, FIPS_MANUAL
, NON_FIPS_MANUAL
, GET_MAC_ADDRESS_TABLE
]
The deployment values.
The description of the element. Max length = 256.
events BaseEventState[]
The details of the events occurred.
The event code.
The event ID.
Id
The priority set for the event.
The standing event. True or False.
The events are suppressed. True or False.
suppressed_info SuppressedInfo
The information on the suppressed events.
The event IDs of the root causes.
The suppressed event time.
The time stamp of the event.
The hardware ID.
Id
The model name of the device.
The name of the element. Max length = 128.
Possible values: [PA_WE_DC
, PA_WE_BR
, NONE
, PA_CONN
, SPOKE
, HUB
]
The element role.
The serial number.
The site ID.
The software version.
Possible values: [init
, active
, backup
, unknown
]
The spoke cluster status.
Possible values: [ACTIVE_INIT
, ACTIVE_INVENTORY_IN_PROGRESS
, ACTIVE_INVENTORY_OPERATION_FAILED
, ACTIVE_INVENTORY_GET_PENDING
, ACTIVE_INVENTORY_GET_COMPLETE
, ACTIVE_INVENTORY_POST_PENDING
, ACTIVE_INTF_CONFIG_GET_FAILED
, ACTIVE_INTF_STATE_GET_FAILED
, ACTIVE_READY
, ACTIVE_BOUND_IN_PROGRESS
, ACTIVE_UNBOUND_IN_PROGRESS
, ACTIVE_UNBOUND_FROM_SITE_FAILED
, ACTIVE_BOUND_TO_SITE
, ACTIVE_BOUND_TO_SITE_FAILED
, OOS
, ACTIVE_DECLAIM_IN_PROGRESS
, ACTIVE_DECLAIMED
]
The element state.
List by the ID.
IsSiteDeleted
Site Id
List by the site name.
The site deployment status.
The description of the site deployment status.
The site template ID.
The site template name. Max length = 128.
List by the site profile updated date.
Data required to deploy new sites at scale using this template.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"created_by": "string",
"deployment_id": "string",
"elements": [
{
"admin_action": "ALLOCATE",
"allowed_roles": [
"NONE"
],
"cluster_insertion_mode": "string",
"cluster_member_id": "string",
"connected": true,
"deployment_op": "DECLAIM",
"events": [
{
"event_code": "string",
"event_id": "string",
"id": "string",
"priority": 0,
"standing": true,
"suppressed": true,
"suppressed_info": {
"root_cause_event_ids": [
"string"
],
"suppressed_time": "2024-07-29"
},
"timestamp": 0
}
],
"hw_id": "string",
"id": "string",
"model_name": "string",
"name": "string",
"role": "PA_WE_DC",
"serial_number": "string",
"site_id": "string",
"software_version": "string",
"spoke_cluster_status": "init",
"state": "ACTIVE_INIT"
}
],
"id": "string",
"isSiteDeleted": true,
"site_id": "string",
"site_name": "string",
"status": "string",
"status_description": "string",
"template_id": "string",
"template_name": "string",
"updated_by": "string",
"variable_map": {}
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INPUT_JSON_EMPTY"
}
]
}
}