Inventory Device Whip

Endpoints Summary

Method Path Swagger GET /inventory_device_whip/{id}/ Swagger ↗

---

The Inventoryinventory Devicedevice WHIPwhip endpointsAPI provideprovides remote device management capabilities, allowing youadministrators to execute critical operations on network devices through thea WHIPcentralized (Web-basedcontrol Hardwareinterface. InterfaceThis Protocol).endpoint Theseenables endpointsremote enable administrators to perform essential maintenance tasks like reboots,rebooting, factory resets, configuration synchronization, and configurationdevice synchronizationreconfiguration remotely.operations for efficient device lifecycle management.

Base URL: https://control.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The Inventoryinventory Devicedevice WHIPwhip API category is designed for remote device management and control operations within yourin network infrastructure.infrastructure environments. This API allowscategory networkprovides administratorsa andsecure automatedinterface systemsfor toexecuting performadministrative critical maintenance operationscommands on managed devices without requiring physical access.

access

Theor WHIP (Web-based Hardware Interface Protocol) integration enables you to execute variousdirect device operations remotely, including system reboots, factory resets, configuration synchronization, and device reconfiguration. This is particularly valuable for managing distributed network infrastructure, IoT devices, or equipment in remote locations where physical access is limited or costly.connections.

Key Operations Available:Capabilities:

• RebootRemote Rebooting:: PerformRestart adevices softto restartresolve ofperformance theissues deviceor apply configuration changes
• Factory Reset Operations:: ResetRestore devicedevices to factory defaults (preservesor networkperform connectivity)

Device Factory Reset: Completedevice-specific factory reset including network settingsresets Configuration SyncManagement:: Synchronize device configurationconfigurations withand thetrigger centralreconfiguration management systemprocesses DeviceCentralized ReconfigureControl:: ApplyManage newmultiple configurationdevices parametersfrom toa thesingle deviceAPI interface

ThisCommon Use Cases:

Network troubleshooting and maintenance workflows Bulk device provisioning and deployment Automated device recovery procedures Configuration drift remediation Scheduled maintenance operations

The API isfollows commonlya usedcommand-based inapproach networkwhere operations centersare (NOCs),specified automatedusing maintenancepredefined workflows,operation codes, ensuring consistent and reliable device lifecycle management systems.across different hardware types and vendors.

---

Endpoints

GET /inventory_device_whip/{id}/

Description: Retrieves the current WHIPdevice operation statusconfiguration orand initiatesavailable a device operationcommands for a specific inventorymanaged device. This endpoint servesprovides asinformation bothabout asupported status checkeroperations and operationcurrent trigger,device dependingstate, onallowing howadministrators it'sto called.understand Thewhat operationmanagement parameteractions determines which remote action willcan be performed on the target device.

Use Cases:

• RemotelyVerify rebootavailable unresponsiveoperations networkbefore devices

Perform scheduled factory resets during maintenance windows Synchronizeexecuting device configurations after policy updates Reconfigure devices with new network parameterscommands Check thecurrent device management status ofand ongoingcapabilities Validate device accessibility for remote operations Audit device management configurations

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_whip/12345/?operation=reboot

Parameters:

Parameter	Type	In	Required	Description
id	integer	path	Yes	The uniqueUnique identifier of the inventorymanaged device to perform theretrieve operation on

information operation string query No The operation to perform on the device. When provided, triggers the specified action

Operation Values:

Value Description reboot Performs a soft reboot of the device while preserving all configurations factory Resets device to factory defaults but maintains network connectivity settings device_factory Complete factory reset including all network and configuration settings sync Synchronizes the device configuration with the central management system reconf Applies new configuration parameters and reconfigures the devicefor

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_whip/12345/?operation=reboot"" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "id": 12345,
  "operation": "reboot",
  "status": "initiated",
  "device_info": {
    "device_id": 12345,
    "device_name": "switch-floor-2-east"Switch-Floor-3-A",
  "device_type": "network_switch",
  "model": "Cisco Catalyst 2960",
  "serial_number": "SW2E-8845-XXYY"FCW2147L0GH",
  "ip_address"management_ip": "192.168.2.45"1.100",
  "location": "Building A - Floor 2 East"
  }3",
  "operation_details"available_operations": [
    "reboot",
    "factory", 
    "device_factory",
    "sync",
    "reconf"
  ],
  "last_operation": {
    "initiated_at"operation": "sync",
    "timestamp": "2024-01-15T14:30:00Z",
    "estimated_completion"status": "2024-01-15T14:32:00Z"completed",
    "operation_id"initiated_by": "op_67890abcdef"admin@company.com"
  },
  "device_status": "online",
  "firmware_version": "15.2(7)E3",
  "uptime": "45 days, 12:34:56"
}

StatusOperation CheckTypes Example (without operation parameter):Reference:

Operation Code Description Use Case curlreboot -XStandard GETdevice "https://control.zequenze.com/api/v1/inventory_device_whip/12345/"restart \Apply -Hconfiguration "Authorization:changes, Bearerresolve YOUR_API_TOKEN"performance \issues -H "Content-Type:application/json"factory Complete factory reset Return device to original factory state device_factory

StatusDevice-specific Responsefactory Example:reset

Vendor-specific factory reset procedure

{sync "id":Configuration 12345,synchronization "operation":Update "reboot",device "status":with "completed",latest "last_operation":configuration {from "operation_type":management "reboot",system "initiated_at": "2024-01-15T14:30:00Z","completed_at":reconf "2024-01-15T14:31:45Z",Device "result":reconfiguration "success",Apply "operation_id":new "op_67890abcdef"configuration },parameters "device_info":without {full "device_id":reset 12345, "device_name": "switch-floor-2-east", "online_status": "online", "last_seen": "2024-01-15T14:32:15Z" } }

Response Codes:

Status	Description
200	Success - OperationReturns initiated or status retrieved successfully

400 Bad Request - Invaliddevice operation parameter or malformed requestinformation 401 Unauthorized - Invalid or missing APIauthentication token 403 Forbidden - Insufficient permissions for device access 404 Not Found - Device ID does not exist or is not accessible 409500 ConflictInternal -Server Another operation is currently in progress on this device 503 Service UnavailableError - Device iscommunication offline or unreachablefailure

---

Common Use Cases

Use Case 1: Automated Network MaintenanceTroubleshooting Workflow

Schedule periodic reboots ofWhen network devices duringexperience maintenanceconnectivity windowsor performance issues, administrators can use this endpoint to preventverify memorydevice leaksaccessibility and ensureexecute optimalremote performance.reboots Useto theresolve rebootcommon operationproblems integratedwithout withrequiring youron-site maintenance scheduling system.visits.

Use Case 2: Configuration Drift Remediation

When monitoring systems detectRegular configuration drift,audits usemay reveal devices that have drifted from standard configurations. Use the sync operation to restore devicesproper configurations and the reconf operation to theirapply intendedupdated configurationpolicies stateacross withoutthe manualnetwork intervention.infrastructure.

Use Case 3: Device DeploymentReplacement and Provisioning

During devicehardware replacementrefresh or new deployments,cycles, use factory or device_factory operations to prepare devices for redeployment, followed by reconfsync operations to ensureapply devicesappropriate start with a clean state and receive the correct configurationconfigurations for theirnew locationnetwork and role.locations.

Use Case 4: Scheduled Maintenance Operations

Implement automated maintenance workflows that check device status and execute planned operations during maintenance windows, such as configuration updates followed by controlled reboots.

Use Case 5: Emergency Recovery OperationsProcedures

When devices become unresponsive or misconfigured, use thethis appropriateAPI factoryto resetexecute operationrecovery (factoryoperations orremotely, device_factory)potentially basedavoiding oncostly whethersite visits and reducing network connectivity needs to be preserved for remote recovery.

Use Case 5: Bulk Configuration Updates

After updating network policies or security settings, use the reconf operation across multiple devices to ensure consistent policy enforcement throughout your infrastructure.downtime.

---

Best Practices

• Operation SequencingSequencing:: WaitAlways forretrieve completiondevice of one operationinformation before initiatingexecuting anotheroperations onto theverify same device. Check operationdevice status usingand theavailable endpoint without parameters.

  commands

• Error HandlingHandling:: Implement retry logic with exponential backoff for network-related failures, as device operations thatmay failtake duetime to temporary network issues. Monitor for 409 status codes indicating conflicting operations.

  complete

• Maintenance Windows: Schedule disruptive operations (factory resets, reboots) during planned maintenance windows to minimize service impact.

Monitoring Integration: Integrate WHIP operations with your network monitoring system to track device recovery after operationsLogging and detectAuditing: anyRecord issues.

all

Documentation: Always log WHIPdevice operations with timestamps and reasonsuser information for audit trailscompliance and troubleshooting purposes.

purposes

Timeout Handling: Set appropriate timeouts for operations. Reboots typically complete in 2-3 minutes, while factory resets may take 5-10 minutes depending on the device type.

Batch OperationsProcessing:: When performing the same operation onmanaging multiple devices, implement parallelappropriate executiondelays withbetween reasonable concurrency limitsoperations to avoid overwhelming thenetwork infrastructure

Validation: Verify device accessibility and current status before executing destructive operations like factory resets Monitoring: Implement post-operation monitoring to confirm successful completion of device commands Security: Use device-specific authentication and ensure operations are performed over secure, encrypted connections Documentation: Maintain detailed records of device configurations and operation procedures for consistent management infrastructure. practices