Gateways
Create Gateway on nSA UI
Copy
Get <Gateway IP address>/api/v1/nsa/registration-status
POST https://<Controller hostname>/api/gateways
Payload:
{"name":"test","gateway_type":"pcs_gateway","location":{"name":"Bengaluru","city_id":99}}
response:
{
"actions": [
"change_settings"
],
"auto_upgrade": true,
"created": "2024-07-10T09:46:33Z",
"default_log_config_udpated": "success",
"gateway_type": "pcs_gateway",
"id": "88b17dff19694e54b3ee09726957abfe",
"is_ready": false,
"location": {
"city_id": 99,
"name": "Bengaluru"
},
"name": "test",
"notification_channel_status": "offline",
"sdp_mode": "pzt-gateway",
"state": "unregistered",
"updated": "2024-07-10T09:46:33Z",
"versions": []
}
Gateway Registration Code and FQDN
Copy
Get <Gateway IP address>/api/v1/nsa/registration-status
GET regsitration code and FQDn:
https://<Controller hostname>/api/gateways/88b17dff19694e54b3ee09726957abfe/orchestration/registration-details
{
"code": "RR7YzsZS4L",
"fqdn": "toad1.toad.pzt.dev.perfsec.com"
}
Gateway Registration
Copy
Post <Gateway IP address>/api/v1/nsa/register
REQUEST
{
"reg_host_fqdn":"xxxxxxxx",
"reg_code":"xxxxxx",
"nw_interface":"internal",
"use_proxy":"false"
}
RESPONSE
{
"success":"Successfully triggered registration"
}
Gateway Registration Status
Copy
Get <Gateway IP address>/api/v1/nsa/registration-status
REQUEST
Get <Gateway IP address>/api/v1/nsa/registration-status
RESPONSE
{
"gateway-id": "xxxxxxxxxxx",
"notification-status": "success",
"notification-status-message": "The Notification Channel is Connected.",
"notification-url": "wss://marjoram4.e.marjoram.pzt.dev.perfsec.com/api/v1/notifications",
"reg-status-message": "success",
"reg-status-message": ""
}
All Gateways List
Copy
GET https://<Controller hostname>/api/gateways/all?gateway_types=pcs_gateway
{
"items": [
{
"appliance_version": "22.7R2-2616",
"created": "2024-06-21T06:10:12Z",
"gateway_type": "pcs_gateway",
"group_id": "52ee9eff68b04776b43cbe50adb8252a",
"id": "9e45ddf785e74a2d87271f88a3e1eff6",
"location": {
"city_id": 99,
"name": "Bengaluru"
},
"model": "ISA-V(VMware)",
"name": "gateway-12345678901",
"rollback_version": "22.7R2-2408",
"sdp_mode": "pzt-gateway",
"serial_number": "VASPHY3C9JQKI133S",
"state": "registered",
"type": "VPN",
"updated": "2024-06-26T12:16:44Z"
},
{
"appliance_version": "22.7R2.1-2951",
"created": "2024-06-25T05:01:59Z",
"gateway_type": "pcs_gateway",
"id": "38ce6e0212214b94a25f8530feb76d64",
"location": {
"city_id": 99,
"name": "Bengaluru"
},
"model": "ISA-V(VMware)",
"name": "ivanti_target-gw2",
"rollback_version": "22.6R2.3-2793",
"sdp_mode": "pzt-gateway",
"serial_number": "VASPHTYHJQACB90YS",
"state": "registered",
"type": "VPN",
"updated": "2024-06-25T09:40:22Z"
},
{
"appliance_version": "22.7R2.1-2951",
"created": "2024-06-25T05:03:23Z",
"gateway_type": "pcs_gateway",
"id": "4963681c7a7d4fdaa78888df5ddae749",
"location": {
"city_id": 99,
"name": "Bengaluru"
},
"model": "ISA-V(VMware)",
"name": "ivanti_target-gw3",
"rollback_version": "22.6R2.3-2793",
"sdp_mode": "pzt-gateway",
"serial_number": "VASPHUUSOXBTU9H7S",
"state": "registered",
"type": "VPN",
"updated": "2024-06-25T09:40:53Z"
},
],
"total": 6
}
Getting Single Gateway Details based on Gateway ID
Copy
Get
Request URL: https://<Controller hostname>/api/gateways/38ce6e0212214b94a25f8530feb76d64
Response:
{
"appliance_version": "22.7R2.1-2951",
"auto_upgrade": true,
"capabilities": [
"readiness",
"reboot",
"rollback",
"action",
"action_snapshot",
"action_debug_log",
"action_ping",
"action_nslookup",
"action_arp",
"action_traceroute",
"action_avgrtt",
"action_portprobe",
"action_tcp_dump",
"action_node_monitoring",
"configurable_session_timeouts",
"restart_services",
"integrity_checker",
"pcs_config_authoring"
],
"created": "2024-06-25T05:01:59Z",
"default_log_config_udpated": "success",
"gateway_type": "pcs_gateway",
"id": "38ce6e0212214b94a25f8530feb76d64",
"is_ready": false,
"location": {
"city_id": 99,
"name": "Bengaluru"
},
"model": "ISA-V(VMware)",
"name": "ivanti_target-gw2",
"notification_channel_status": "offline",
"rollback_version": "22.6R2.3-2793",
"sdp_mode": "pzt-gateway",
"serial_number": "VASPHTYHJQACB90YS",
"state": "registered",
"type": "VPN",
"updated": "2024-06-25T09:40:22Z",
"versions": []
}
Salient Tasks
Copy
Get
/api/gateways/salient-tasks
Response
{
"items": [
{
"gateway_id": "d5da0263a8d94fd9823ba5568db397b1"
},
{
"gateway_id": "0183c3d395944b5691c7579470c7181d"
}
],
"total": 2
}
Gateway Upgrade from nSA
Getting Available Upgrade Package Details
Copy
Get
Request
api/gateways/packages?gateway_type=pcs_gateway&package_type=upgrade
{
"items": [
{
"appliance_version": "22.2R1-480",
"created": "2022-06-30T12:37:49Z",
"gateway_type": "pcs_gateway",
"group_id": "d71c033b923a48b191441e7947bc9677",
"id": "d5e8bd43f68b4a52b95854e7fa7c8509",
"location": {
"name": "blr"
},
],
"total": 1
}
ICS Gateway Upgrade
Copy
Get
Request
{
/api/gateways/{gateway-id}/settings/prescribed
payload = {"version": "9.3R4"}
}
Multinode Upgrade
Copy
Get
Request
{
/api/pcs-configs/multinode/install
payload={
"version": "22.7R1",
"clusterIds": [group_ids],
"gatewayIds": [gateway_ids],
}
}
ICS Cluster Upgrade
Copy
Get
Request
{
/api/pcs-configs/groups/{cluster_id}/install
payload: {"version": "22.7R1"}
}