Skip to main content

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

    tenant_id stringrequired

    The tenant ID.

Body

Details of the Site Profile to be created

    aggregate Aggregate

    The aggregate number of site profiles that match the query parameters.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
    • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
    • field string

    Field

    name string

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]

    Operator

    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number site profiles; deleted for a time frame.

    group_by string[]

    Group the site profiles for the query.

    id string

    List the site profiles by ID.

    last_query_ts int64

    Return the ID of a specified query in the current session.

    limit int32

    The query limit.

    next_query object

    The limit.

    query_params object
    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object
    total_count int64

    The total number of query parameters.

Responses​

Successful Operation

Schema
    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.

    description

    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number.

    items BulkConfigPushQueryFilter[]
  • Array [
    • created_by string

    List by the site profile created date.

    deployment_id string

    List by the site deployment ID.

    elements ElementQueryFilter[]

    List by the following element details.

  • Array [
    • admin_action string

    Possible values: [ALLOCATE, CLAIM, BOUND, UNBOUND, DECLAIM, RETURN, REVOKE, RETIRE, STOCK, UPGRADE, REMANUFACTURE, DEFAULT, INVALID]

    The values of admin actions that can be performed.

    allowed_roles string[]

    Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]

    The allowed roles.

    cluster_insertion_mode string

    The element ID.

    cluster_member_id string

    The cluster member ID.

    connected boolean

    The element is connected. True or False.

    deployment_op string

    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.

    description

    The description of the element. Max length = 256.

    events BaseEventState[]

    The details of the events occurred.

  • Array [
    • event_code string

    The event code.

    event_id string

    The event ID.

    id string

    Id

    priority int32

    The priority set for the event.

    standing boolean

    The standing event. True or False.

    suppressed boolean

    The events are suppressed. True or False.

    suppressed_info SuppressedInfo

    The information on the suppressed events.

    root_cause_event_ids string[]

    The event IDs of the root causes.

    suppressed_time date

    The suppressed event time.

    timestamp int64

    The time stamp of the event.

  • ]
    • hw_id string

    The hardware ID.

    id string

    Id

    model_name string

    The model name of the device.

    name string

    The name of the element. Max length = 128.

    role string

    Possible values: [PA_WE_DC, PA_WE_BR, NONE, PA_CONN, SPOKE, HUB]

    The element role.

    serial_number string

    The serial number.

    site_id stringrequired

    The site ID.

    software_version string

    The software version.

    spoke_cluster_status string

    Possible values: [init, active, backup, unknown]

    The spoke cluster status.

    state string

    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]

    The element state.

  • ]
    • id string

    List by the ID.

    site_name string

    List by the site name.

    status string

    The site deployment status.

    status_description string

    The description of the site deployment status.

    template_id string

    The site template ID.

    template_name string

    The site template name. Max length = 128.

    updated_by string

    List by the site profile updated date.

    variable_map object

    Data required to deploy new sites at scale using this template.

  • ]
Loading...