API Reference SFD REST APIs API Version: 2.0 SmartFabric Director REST API doc.
INDEX 1. ABOUT 9 1.1 GET /about 9 2. ALERTS 11 2.1 GET /alerts 11 2.2 POST /alerts/{id}/ack 12 2.3 POST /alerts/{id}/unack 14 2.4 POST /alerts/{id}/clear 16 2.5 GET /alerts/{id}/events 17 2.6 GET /alerts/{id}/timeline 19 3. AUTHENTICATION 21 3.1 POST /auth/token 21 3.2 POST /auth/token/extend 22 3.3 GET /auth/users 23 3.4 POST /auth/users 25 3.5 GET /auth/users/{userId} 26 3.6 PUT /auth/users/{userId} 28 3.7 DELETE /auth/users/{userId} 29 3.
4.14 GET /backups/restore/status 66 4.15 POST /backups/restore/status 68 5. BARE-METAL-HOST 70 5.1 GET /fabric-intents/{fabric-intent-id}/bare-metal-hosts 70 5.2 POST /fabric-intents/{fabric-intent-id}/bare-metal-hosts 71 5.3 GET /fabric-intents/{fabric-intent-id}/bare-metal-hosts/{id} 73 5.4 PUT /fabric-intents/{fabric-intent-id}/bare-metal-hosts/{id} 76 5.5 DELETE /fabric-intents/{fabric-intent-id}/bare-metal-hosts/{id} 77 5.
10.6 POST /fabric-intents/{id}/clone 127 10.7 POST /fabric-intents/{id}/check-deploy-impact 129 10.8 GET /fabric-intents/{id}/configurations 130 10.9 POST /fabric-intents/{id}/approval-request 134 10.10 POST /fabric-intents/{id}/cancel-approval 135 10.11 POST /fabric-intents/{id}/validate 137 10.12 POST /fabric-intents/{id}/deploy 138 10.13 GET /fabric-intents/{id}/deploy-status 140 10.14 GET /fabric-intents/{fabric-intent-id}/deployments/{deployment-id} 142 11. HOST-NETWORK 145 11.
16.1 POST /metrics 210 16.2 POST /metrics/aggregation 213 16.3 POST /metrics/distribution 215 17. MULTI-TENANCY 219 17.1 GET /fabric-intents/{fabric-intent-id}/tenants 219 17.2 POST /fabric-intents/{fabric-intent-id}/tenants 220 17.3 GET /fabric-intents/{fabric-intent-id}/tenants/{id} 222 17.4 PUT /fabric-intents/{fabric-intent-id}/tenants/{id} 224 17.5 DELETE /fabric-intents/{fabric-intent-id}/tenants/{id} 225 17.
22.1 POST /switches/{switch-id}/reboot 271 22.2 POST /switches/{switch-id}/interfaces/{interface-id}/admin-status 272 23. SWITCH-GROUP 275 23.1 GET /switch-groups 275 23.2 POST /switch-groups 276 23.3 GET /switch-groups/{id} 277 23.4 PUT /switch-groups/{id} 279 23.5 DELETE /switch-groups/{id} 281 23.6 GET /switch-groups/{id}/support-matrix 282 24. SYSLOG 285 24.1 GET /syslogs/messages 285 24.2 GET /syslogs/messages/latest 286 25. SYSTEM 288 25.1 GET /system/health 288 25.
30.1 GET /vm-managers 323 30.2 POST /vm-managers 324 30.3 GET /vm-managers/{id} 325 30.4 PUT /vm-managers/{id} 327 30.5 DELETE /vm-managers/{id} 329 31. WIRING DIAGRAM 331 31.1 POST /wiring-diagrams 331 31.2 DELETE /wiring-diagrams/{id} 332 31.3 GET /wiring-diagrams/{id}/topology 334 31.4 GET /wiring-diagrams/summary 336 31.5 GET /wiring-diagrams/{id}/compatible-intents 337 31.
Security and Authentication SECURITY SCHEMES KEY TYPE DESCRIPTION nfc_api_key apiKey Each API needs token in 'Authorization' header. The token can be retrieved by using API- POST /auth/token. The token retrieved from this request should be sent in 'Authorization' header as 'NFC {token}' Example : curl -X GET https://SFD-IP/api/fabric-intents \ -H 'Accept: application/json' \ -H 'Authorization: NFC eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9' \ -H 'Cache-Control: no-cache' \ -H 'Content-Type: application/json' \
API 1. ABOUT About SFD. 1.1 GET /about Get information about SFD. This API should be invoked to get SFD version and service-tag. REQUEST No request parameters RESPONSE STATUS CODE - 200: Get SFD version and service-tag information. RESPONSE MODEL - application/json { version string service_tag string manifest_file_version string version of SFD. unique service tag provided with SFD purchase. The manifest file version. } STATUS CODE - 401: You are not authorized to perform this operation.
id string message string field_name string messageParams [string] } This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
2. ALERTS Alerts generated in the NFC 2.1 GET /alerts Returns all active alerts. This API returns all the active alerts generated within NFC. An alert is raised when an instance of an event type occurs with certain severity level. An alert is cleared when an instance of an event type occurs with certain severity level. For example CPU usage crossing a threshold 'X' will raise HIGH_CPU_USAGE_ALERT and CPU usage below a threshold 'X' will clear HIGH_CPU_USAGE_ALERT.
Severity level of the events/alerts created_timestamp integer modified_timestamp integer cleared_timestamp integer message string referenced_object_id { The time in seconds since epoch at which the alert was generated. The time in seconds since epoch at which the alert was modified. The time in seconds since epoch at which the alert was cleared/resolved.
Update the state of an alert to ACK state. This API updates the state of an alert from OPEN to ACK state. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *id string The alert Id to be acknowledged. RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
messageParams [string] } Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
2.4 POST /alerts/{id}/clear Clears an alert. This API clears the given alert. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *id string The alert Id to be cleared. RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
id message messageParams string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string.
Severity level of the events/alerts timestamp integer The time in seconds since epoch at which the event was generated. message string Detailed message describing the generated event. referenced_object_id { This object defines the NFC object type and the unique identifier for that object type } id string type string Unique identifier of the referenced object Type of referenced object. Ex - Interface, Switch, etc }] } STATUS CODE - 401: You are not authorized to perform this operation.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } 2.6 GET /alerts/{id}/timeline Returns the alert timeline by alert Id This API returns the alert timeline history.
} STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
3. AUTHENTICATION Get access to the APIs 3.1 POST /auth/token Retrieve new token This API should be invoked first to get the API token. The returned token to be used for all the other APIs. The token return has validity of 30 min. This api will also return refresh token which is used to get the new token before the token is expired. To extend the token use /auth/token/extend api.
messageParams messages [{ [string] Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
message messageParams string [string] messages [{ Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
RESPONSE STATUS CODE - 200: Get all users details configured with NFC RESPONSE MODEL - application/json { data [{ Array of object: first_name last_name user_id overall_state string string string enum DEFAULT:ACTIVE ALLOWED:ACTIVE, INACTIVE Tells if the user overall user status is ACTIVE or INACTIVE.
Success or error message message string field_name string messageParams [string] } Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 3.4 POST /auth/users Create new local user. This API should be invoked to create a local user, and used to SFD-domain only.
id message messageParams This represents the key for the localized property file to be used by UI to show the localized string. string string [string] Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string.
cli_state enum user_role enum ad_user contact_number updated_by last_updated boolean string string integer DEFAULT:ACTIVE ALLOWED:ACTIVE, ENABLE_IN_PROGRESS, DISABLE_IN_PROGRESS, INACTIVE, SSH_CREATION_FAILED Tells if the user CLI access is ACTIVE or INACTIVE or change is IN_PROGRESS. SSH_CREATION_FAILED happens when SSH access creation fails, during which deletion and recreation of user is recommended. DEFAULT:ADMIN ALLOWED:ADMIN Tells if it is AD user.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 3.6 PUT /auth/users/{userId} Update user info. This API should be invoked to update user data.
messageParams [string] Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
NAME TYPE *userId string DESCRIPTION userId parameter as input to delete user. RESPONSE STATUS CODE - 202: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
Message in the localized file. } }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } STATUS CODE - 401: You are not authorized to perform this operation.
messageParams [string] } Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 3.9 PUT /auth/users/self/password Change existing password by user. This API should be invoked to change their existing password by user. REQUEST REQUEST BODY - application/json { old_password* string 8 to 20 chars old password.
}] messageParams [string] Message in the localized file. } STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
RESPONSE STATUS CODE - 202: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
REQUEST PATH PARAMETERS NAME TYPE *userId string DESCRIPTION userId parameter to change user state. REQUEST BODY - application/json { user_state boolean DEFAULT:true Tells if the user is enabled/disabled. If disabled means user can not login. } RESPONSE STATUS CODE - 202: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
REQUEST No request parameters RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
} STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
4. BACKUP Backup APIs related to backup and restore of SFD database. 4.1 GET /backups/locations Get list of all configured backup location. All the SFD backup data will get uploaded to the backup location.
Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messageParams [string] } }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
field_name string messageParams [string] }] Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } STATUS CODE - 400: Invalid request. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
} 4.3 PUT /backups/locations/{id} Modify backup location configurations REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *id string Unique identifier of the backup location to be updated REQUEST BODY - application/json { Remote location to backup SFD data. It can be either FTP or SFTP server. host* string IP or FQDN of backup location server. 1. IP address and port (x.x.x.x:) 2. FQDN (domain.com) 3. If the port is not provided then default port for specified protocol will be considered.
Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } STATUS CODE - 401: You are not authorized to perform this operation.
field_name string messageParams [string] }] Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } 4.4 DELETE /backups/locations/{id} Deletes a configured backup location By Id This api deletes configured backup location used for uploading SFD backup data.
STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
user_info { This object describes the user information with respect to object like who created or updated the object created_by created_at last_updated_by last_updated_at } name* location* content* string integer string integer Name of the user who created the object.
Message in the localized file. } }] 4.6 POST /backups/jobs Add a backup job to backup SFD data periodically or on demand. REQUEST REQUEST BODY - application/json { Backup job to take backup of SFD data periodically name* location* content* string string [enum] description frequency* string enum Defines the prefix of the SFD backup tar Configured backup location unique identifier ALLOWED:CONFIG_DATA, EVENTS_AND_LOGS_DATA, MONITORING_DATA The type of SFD data being backed up.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation.
RESPONSE STATUS CODE - 200: Response to get single backup job by id. RESPONSE MODEL - application/json { Backup job to take backup of SFD data periodically id status string enum Unique identifier of the Backup Job ALLOWED:ACTIVE, EXPIRED Backup job status. If it is expired it will stop generating backup instances.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
backup_instances integer Defines the number of instances after which backup job will stop taking further backups. This field is needed if the recurrence type is NUMBER_OF_BACKUPS. } RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id string string This represents the id of the new object created for the POST API call.
message string field_name string messageParams [string] } Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
ANOTHER_BACKUP_IN_PROGRESS, NOT_SET size version content integer string [enum] the current status of this backup instance. Size of the backup tar file in KB. SFD Version ALLOWED:CONFIG_DATA, EVENTS_AND_LOGS_DATA, MONITORING_DATA location start_time completed_time } string integer integer job_name string description string additional_information string The type of SFD data being backed up. Path on Remote location at which backup tar is uploaded Time in seconds since epoch at which backup was taken.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
messageParams messages [{ [string] Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } 4.13 POST /backups/restore Initiate a restore by given backups id.
STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
The type of SFD data being backed up. size backup_time version integer integer string The size of this backup file in KB. Time at which the backup was taken. The timestamp is defined in epoch milliseconds. Version of SFD. This field is needed for getting restore status. It is not needed when retrieving backups. } restore_info { Information about the restore result. It will be shown in restore detail page once restore is completed.
field_name string messageParams [string] }] Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } 4.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
5. BARE-METAL-HOST Bare Metal Host object within a fabric intent 5.1 GET /fabric-intents/{fabric-intent-id}/bare-metal-hosts Retrieve all Bare Metal Host objects within a fabric intent. This API returns all bare metal host objects within a fabric intent identified by 'fabric-intent-Id'.
metal hosts, 1) It can be used to get all the leaf switch ports tha are connected to the host. 2) It can be used to get all available ports on a leaf switch, which can then be used to configure a host. For other cases, it can be use to fetch port information for a switch.
allowed VLANs and switched interfaces on the leaf switches during deployment, so that traffic from these hosts can be handled. This operation can only be done on a fabric intent in DRAFT state. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *fabric-intent-id string Unique identifier of the fabric intent REQUEST BODY - application/json { Represents all the input parameters required to configure a Bare Metal Host or Service Appliance.
messageParams Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. [string] messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
NAME TYPE DESCRIPTION *fabric-intent-id string Unique identifier of the fabric intent *id Unique identifier of the bare metal host object string RESPONSE STATUS CODE - 200: Response to get a Bare Metal Host or Service Appliance RESPONSE MODEL - application/json { A list of all the configured Bare Metal Hosts or Service Appliances data [{ Array of object: Represents all the configurations details of a Bare Metal Host or Service Appliance.
} }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
5.4 PUT /fabric-intents/{fabric-intent-id}/bare-metal-hosts/{id} Update a Bare Metal Host object within a fabric intent. This API updates a bare metal host object identified by 'id' within a fabric intent identified by 'fabric-intent-Id'. This operation can only be done if the fabric intent is in DRAFT state.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *fabric-intent-id string Unique identifier of the fabric intent *id Unique identifier of the bare metal host object string RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
2) It can be used to get all available ports on a leaf switch, which can then be used to configure a host. For other cases, it can be use to fetch port information for a switch. switch_id string switch_name string ports [{ Unique identifier of the switch Name of the switch Array of object: port_id string port_name string Unique identifier of the port Name of the port }] } switch_2 { A model representing a switch, and some/all of the ports on it.
Message in the localized file.
6. CONFIG Switch configuration based on fabric intent. 6.1 GET /fabric-intents/{fabric-intent-id}/configurations/vlans Retrieve host network generated configuration for this Fabric-Intent This api returns the generated configuration for host networks. This comprises VLANs , port channel and member interfaces. The port channel information will be returned for the deployed fabric intents. This also return the lag id for leafpairs for the port channel.
intf_name ip_address The name of the VLAN interface . string string The ip address for the VLAN interface. }] port_channels [{ Array of object: The Port channel information for the Vlans created on leaf switches. port_channel_name string lag_id integer The name of port channel configured on switch. switch_id switch_name members [{ The unique identifier of the Leaf switch on which port channel is created. string string The lag id on the port channel.
STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
PATH PARAMETERS NAME TYPE DESCRIPTION *id string Unique identifier of the fabric intent. RESPONSE STATUS CODE - 200: Response to get a list of bgp neighbor details for every switch managed by SFD. RESPONSE MODEL - application/json { List of BGP neighbor details for each switch. data [{ Array of object: The BGP configuration on the switch switch_id name switch_role string string enum Id of the switch.
messageParams Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. [string] messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
Details of the peer switch for the VLT link. domain_id integer switch_id string switch_name string VLT domain ID. The peer switch ID. The peer switch name. } links [{ Array of object: self_interface { The information about an Ethernet interface. id name switch_id switch_name string string string string The object id of the interface. the name of the interface. Oid of the switch, on which the interface resides. Name of the switch, on which the interface resides.
Message in the localized file. } }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
}] } } }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
} 6.6 GET /fabric-intents/{id}/configurations/l3-interlinks Retrieves all the port channel configurations In an L3 fabric, it retrieves port channels between all the spine and leaf/edge-leaf pairs in the fabric. In an L2 fabric, it retrieves port channels between all the spine and edge-leaf pairs in the fabric. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *id string Unique identifier of the fabric intent.
links [{ Array of object: leaf_interface { The information about an Ethernet interface. id name switch_id switch_name string string string string The object id of the interface. the name of the interface. Oid of the switch, on which the interface resides. Name of the switch, on which the interface resides. } spine_interface { The information about an Ethernet interface. } }] id name switch_id switch_name string string string string The object id of the interface. the name of the interface.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
id name switch_id switch_name members [{ string string string string ID of the port channel. Name of the port channel. ID if the switch, whose interfaces are part of this port channel. Name of the switch, whise interfaces are part of this port channel. Array of object: The information about an Ethernet interface. id name switch_id switch_name }] lag_id string string string string The object id of the interface. the name of the interface. Oid of the switch, on which the interface resides.
messageParams [string] Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
switch_2_id string switch_2_name string }] Unique identifier of switch-2 in the leaf pair. Name of switch-2 in the leaf pair. }] } STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
} }] 6.9 GET /fabric-intents/{id}/configurations/vxlan-segments Retrieves Vxlan Segment configurations in an Vxlan Overlay over L3 fabric. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *id string Unique identifier of the fabric intent. QUERY PARAMETERS NAME TYPE switch-id string DESCRIPTION If switch id is passed then Vxlan Segments on this switch Id will be only returned RESPONSE STATUS CODE - 200: Response to get a list of all Vxlan Segment configurations in an Vxlan OVerlay over L3 fabric.
vlan_id integer }] description } The vlan-id on each rack, which this segment stretches on to. string An optional description for the VxLAN segment. }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
} }] 6.10 GET /fabric-intents/{id}/configurations/tenants Retrieves configurations for all the tenants using the fabric. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *id string Unique identifier of the fabric intent. RESPONSE STATUS CODE - 200: Response to get a list of configurations generated for all the tenants using the faric. RESPONSE MODEL - application/json { List of configurations generated for all the tenants using the fabric.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
Array of object: Name and description ref object id tenant { string Unique identifier of the nfc host network object. Represents a tenant using the fabric. tenant_id string name* string description string Unique identifier of the tenant. Name of the tenant Optional description for the tenant. } tenant_id vlan_id* Unique identifier of the tenant. This is required in a multi-tenant fabric.
id message field_name messageParams This represents the key for the localized property file to be used by UI to show the localized string. string string string [string] Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] } STATUS CODE - 401: You are not authorized to perform this operation.
NAME TYPE DESCRIPTION *fabric-intent-id string Unique identifier of the fabric intent.
STATUS CODE - 400: Invalid request. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
7. EDGE-LEAF Edge leafs Service APIs 7.1 GET /fabric-intents/{fabric-intent-id}/edge/connections Get all Edge-Connections for given fabric-intent-id Retrieves all Edge-Connections REQUEST PATH PARAMETERS NAME TYPE *fabric-intent-id string DESCRIPTION Unique identifier of the fabric intent QUERY PARAMETERS NAME TYPE tenant-id string DESCRIPTION Tenant whose edge connections need to be fetched.
Mask part of the subnet in the CIDR notation } localAsn remoteAsn }] integer integer ASN number of the source, i.e. source of this Edge-Connection ASN number of the destination, i.e.
message messageParams Success or error message string [string] Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
RESPONSE STATUS CODE - 200: Response for Get Edge-Connections by Id RESPONSE MODEL - application/json { id name tenant { string string Unique identifier of the Edge connection of fabric intent Name of this Edge Connection Represents a tenant using the fabric. tenant_id string name* string description string Unique identifier of the tenant. Name of the tenant Optional description for the tenant.
messageParams [string] } Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
8. EVENTS Events generated in the NFC 8.1 GET /events Returns list of NFC events. This API returns all the events generated within NFC. REQUEST QUERY PARAMETERS NAME TYPE DESCRIPTION type string Support partial search for event type. For example, by inputting 'INTERFACE', the returned result will be all events whose type contain "INTERFACE", like INTERFACE_LINK_DOWN_EVENT. severity string Get all the NFC events based on event severity generated within NFC.
} STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
Nfc event object id type severity string string enum Unique identifier of the nfc event object Type of event generated. Ex: INTERFACE_LINK_DOWN_EVENT ALLOWED:INFO, WARNING, ERROR, CRITICAL, CLEARED Severity level of the events/alerts timestamp integer The time in seconds since epoch at which the event was generated. message string Detailed message describing the generated event.
Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
9. FABRIC NFC Fabric 9.1 GET /fabrics Fabric object always point to the active FabricIntent Fabric object is created when any FabricIntent is deployed.
} STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
10. FABRIC-INTENT Fabric intent provisioning 10.
Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 404: Requested entity does not exist.
REQUEST RESPONSE STATUS CODE - 201: New entity created successfully. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
10.3 GET /fabric-intents/{id} Get a Fabric-Intent retrieves a fabric intent represented by the requested 'id'.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } STATUS CODE - 404: Requested entity does not exist.
STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 404: Requested entity does not exist.
NAME TYPE DESCRIPTION *id string Unique identifier of the fabric intent REQUEST BODY - application/json { Inputs required to clone a fabric intent wiring_diagram_id* string Object id of wiring-diagram on which this intent will be applied. } RESPONSE STATUS CODE - 201: New entity created successfully. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
NAME TYPE DESCRIPTION *id string Unique identifier of the fabric intent RESPONSE STATUS CODE - 200: Success response to retrieve the fabric intent configuration RESPONSE MODEL - application/json { This object represents the generated configuration for the fabric intent. switches [{ Array of object: This objects represents the network configuration applied on the switch id name interfaces [{ string string This is unique identifier of the switch in the fabric The name of the switch.
Lists the UFD interfaces and other UFD information for a switch. switch_id string switch_name string enabled boolean group_id integer interface_members [{ ID of the switch. Name of the switch. Represents whether UFD is configured on the switch. The id of the UFD. There will be one UFD object per leaf switch.
Describes the type of connection from one interface to another. endpoint1 { A connection is between two endpoints. This object represents one endpoint of the connection. It tells the switch name, ethernet interface of the endpoint. switch_id switch_name interface_id ipaddress } endpoint2 { string string string string Id of the switch to which this endpoint belongs. The switch name to which this endpoint belongs.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
messageParams [string] Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
NAME TYPE DESCRIPTION *id string Unique identifier of the fabric intent RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
Message in the localized file. } }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
NAME TYPE DESCRIPTION *id string Unique identifier of the fabric intent RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
Message in the localized file. } }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
error_count integer The count of switches where configuration has failed. } deployment_progression [{ Array of object: This object defines the deployment progression on the individual switch id name progress status string string number enum Unique identifier of the switch object Name of the switch. The configuration progress of the switch in percentage. ALLOWED:SUCCESS, IN_PROGRESS, FAILED The configuration status on the switch. timestamp { Time of the start and end of deployment.
} }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
error_count integer The count of switches where configuration has failed. } deployment_progression [{ Array of object: This object defines the deployment progression on the individual switch id name progress status string string number enum Unique identifier of the switch object Name of the switch. The configuration progress of the switch in percentage. ALLOWED:SUCCESS, IN_PROGRESS, FAILED The configuration status on the switch. timestamp { Time of the start and end of deployment.
} }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
11. HOST-NETWORK Host Network object with in a fabric intent 11.1 GET /fabric-intents/{fabric-intent-id}/host-networks Retrieve all Host Network objects within a fabric intent. Optionally, it can be filtered for a single tenant in a multi-tenant fabric. This API returns all host network objects within a fabric intent identified by 'fabric-intent-Id'. Optionally, the host networks can be filtered based on a specific tenant in a multi-tenant fabric.
IP subnet and they are 2 different bcast domains. So, user needs to provide switch ids and SVI, VRRP VIP per leaf pair if the VLAN is going to span multiple leaf switches. But for L2 fabric switch ids are not needed a SVI is configured on Spine switches and there are going to be only two spines. For l3 fabric switch_id_1 and switch_id_2 will be leaf switch ids which are in pair.For l2 fabric these will be spine switches but these are optional because only 2 spine switches will be there.
} }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
switch_id_1 switch_id_2 svi_ip_1* string string string svi_ip_2* string Unique identifier of the switch 1 Unique identifier of the switch 2 PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3} (25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/([0-9]|[1-2] [0-9]|3[0-2])) SVI interface IP for leaf switch in CIDR notation PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3} (25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/([0-9]|[1-2] [0-9]|3[0-2])) SVI interface IP for peer leaf/spine switch in CIDR notation vrrp_vi
} }] STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
RESPONSE MODEL - application/json { Name and description ref object id tenant { string Unique identifier of the nfc host network object. Represents a tenant using the fabric. tenant_id string name* string description string Unique identifier of the tenant. Name of the tenant Optional description for the tenant. } tenant_id vlan_id* Unique identifier of the tenant. This is required in a multi-tenant fabric.
Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } STATUS CODE - 404: Requested entity does not exist.
REQUEST BODY - application/json { Name and description ref object tenant_id vlan_id* Unique identifier of the tenant. This is required in a multi-tenant fabric. string integer between 1 and 4096 type* enum Id of the Vlan on host network ALLOWED:MANAGEMENT_VLAN, VMOTION_VLAN, STORAGE_VLAN, TRANSPORT_VLAN, WORKLOAD_VLAN, OTHER Type of the Vlan 1. MANAGEMENT_VLAN - Management Vlan allows to communicate remotely with a switch. Management Vlan must be provided for all the switches in SFD.
} }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
11.5 DELETE /fabric-intents/{fabric-intent-id}/host-networks/{host-networkid} Delete a Host Network object within a fabric intent. This API deletes a host network object identified by 'host-network-id' within a fabric intent identified by 'fabric-intent-Id'.
new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
12. HOSTS Information about hosts that are connected/discovered in the fabric. 12.1 GET /hosts this API retrieves all the connected/discovered hosts. Retrieve a list of hosts that have been connected/discovered in the fabric. If switch-id param is set, then hosts connected to that switch will be returned. Else, all the hosts in the fabric will be returned.
url string description string username string tenants [{ URL of VM manager description of VM Manager VM Manager username Array of object: Tenant info object tenant_id string tenant_name string }] state enum Unique identifier of the tenant. Name of the tenant.
13. IMAGE-SERVER SFD will use this image-server to upgrade or downgrade image on the switch 13.
messageParams [string] } Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
domain.com: 3. FQDN domain.com base_path protocol* string DEFAULT:/ base directory for image server enum ALLOWED:TFTP, FTP, SFTP, SCP, HTTP supported protocols to access the image server credential { Credentials are not needed for HTTP and TFTP username string password string } name* string PATTERN:^(?!\s*$).+ Name of the object } description string description of the object RESPONSE STATUS CODE - 201: New entity created successfully.
RESPONSE MODEL - application/json { new_object_id id string string This represents the id of the new object created for the POST API call. message messageParams string [string] Success or error message messages [{ This represents the key for the localized property file to be used by UI to show the localized string. Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
string This is unique identifier of the image server string min:1 chars id name name of this image server description string url string base_path string image_source_url string protocol string credential { username string } user_info { description of the imaFabricTopologyServicege server IP or FQDN of image-server base directory for image server READ-ONLY, Source URL of image-server formed by URL and base_path supported protocols to access the image server This object describes the user information wit
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
} }] 167 of 340
14. INTERLINK Interlink object with in a fabric intent 14.1 GET /fabric-intents/{fabric-intent-id}/interlinks Retrieve all Interlink objects with in a fabric intent. This API returns all interlink objects with in a fabric intent identified by 'fabric-intent-Id'.
Loopback subnet seed address which will be used to configure the loopback addresses on the switches. address string DEFAULT:10.10.10.1 PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.
mtu integer DEFAULT:9000 MTU is maximum transmission unit. The fabric intent MTU must match that on the leaf switches. 1. For Vcenter usecase minimum is 1500 and maximum is 9000 bytes. 2. For NSX minimum is 1700 and maximum is 9000. edge_interlink_ebgp { Base model holding interlink address, loopback seed and BGP configurations for an L3 Fabric interlink_subnet { subnet which will be used to configure the interfaces on the switches address* string DEFAULT:192.168.0.
DEFAULT:200 Hello packets transmission interval in milliseconds min_rx integer between 100 and DEFAULT:200 1000 minimum receive interval for Hello packets in milliseconds multiplier integer between 1 and DEFAULT:3 50 Number of Hello packets miss that can be tolerated } enable_edge_bfd boolean BFD state for edge connections } } } BGP_EVPN { Base model holding interlink address, loopback seed and BGP configurations for an L3 Fabric vtep_seed_address { The seed address for VxLAN Tunnel EndPoints.
Array of object: AS (autonoumus system) number for the switches. start integer between 64512 and end integer between 64512 and 65534 65534 }] as_spine_range [{ Array of object: AS (autonoumus system) number for the switches. start integer between 64512 and end integer between 64512 and 65534 65534 }] } bfd { BFD settings for the fabric fabric_bfd_parameters { Parameters of a BFD session. At this time, the parameters are read-only.
} STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
type enum DEFAULT:NOT_DEFINED ALLOWED:NOT_DEFINED, L3_BGP, L3_BGP_NSX_T, L2_VLT, BGP_EVPN Type of the interlink. This defines how the switches are connected. Based on the type set, corresponding object needs to be set with this input. L3_BGP { Base model holding interlink address, loopback seed and BGP configurations for an L3 Fabric ufd boolean rstp DEFAULT:true If this property is enabled then on the leaf switches UFD (Uplink Failure detection) will be configured. Its enabled by default.
min_rx integer between 100 and DEFAULT:200 1000 minimum receive interval for Hello packets in milliseconds multiplier integer between 1 and DEFAULT:3 50 Number of Hello packets miss that can be tolerated } edge_bfd_parameters { Parameters of a BFD session. At this time, the parameters are read-only.
start integer between 64512 and end integer between 64512 and 65534 65534 }] as_spine_range [{ Array of object: AS (autonoumus system) number for the switches. start integer between 64512 and end integer between 64512 and 65534 65534 }] } bfd { BFD settings for the fabric fabric_bfd_parameters { Parameters of a BFD session. At this time, the parameters are read-only.
is 9000. interlink_subnet { subnet which will be used to configure the interfaces on the switches address* string DEFAULT:192.168.0.0 PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3} (25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?) Address part of the subnet in the CIDR notation prefix_len* integer between 1 and DEFAULT:16 32 Mask part of the subnet in the CIDR notation } loopback_seed_address { Loopback subnet seed address which will be used to configure the loopback addresses on the switches.
multiplier integer between 1 and DEFAULT:3 50 Number of Hello packets miss that can be tolerated } enable_edge_bfd } boolean BFD state for edge connections } } RESPONSE STATUS CODE - 201: New entity created successfully. RESPONSE MODEL - application/json { new_object_id id string string This represents the id of the new object created for the POST API call.
messageParams Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. [string] messages [{ Array of object: id string This represents the key for the localized property file to be used by UI to show the localized string. message string field_name string messageParams [string] Success or error message Field name where the error was seen Params array to substitute in the message.
BGP_EVPN Type of the interlink. This defines how the switches are connected. Based on the type set, corresponding object needs to be set with this input. L3_BGP { Base model holding interlink address, loopback seed and BGP configurations for an L3 Fabric ufd boolean rstp DEFAULT:true If this property is enabled then on the leaf switches UFD (Uplink Failure detection) will be configured. Its enabled by default.
minimum receive interval for Hello packets in milliseconds multiplier integer between 1 and DEFAULT:3 50 Number of Hello packets miss that can be tolerated } edge_bfd_parameters { Parameters of a BFD session. At this time, the parameters are read-only.
}] as_spine_range [{ Array of object: AS (autonoumus system) number for the switches. start integer between 64512 and end integer between 64512 and 65534 65534 }] } bfd { BFD settings for the fabric fabric_bfd_parameters { Parameters of a BFD session. At this time, the parameters are read-only.
subnet which will be used to configure the interfaces on the switches address* string DEFAULT:192.168.0.0 PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3} (25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?) Address part of the subnet in the CIDR notation prefix_len* integer between 1 and DEFAULT:16 } loopback_seed_address { 32 Mask part of the subnet in the CIDR notation Loopback subnet seed address which will be used to configure the loopback addresses on the switches. address string DEFAULT:10.10.10.
Number of Hello packets miss that can be tolerated } enable_edge_bfd } boolean BFD state for edge connections } } STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
} }] 14.4 PUT /fabric-intents/{fabric-intent-id}/interlinks/{interlink-id} Update an Interlink object with in a fabric intent. This API updates an interlink object identified by 'interlink-id' with in a fabric intent identified by 'fabric-intent-Id'. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *fabric-intent-id string Unique identifier of the fabric intent *interlink-id Unique identifier of the interlink object string REQUEST BODY - application/json { Input object to create an Interlink object.
bgp { Properties related to BGP configuration type enum DEFAULT:eBGP ALLOWED:eBGP, iBGP type of the BGP network as_leaf_range [{ Array of object: AS (autonoumus system) number for the switches. start integer between 64512 and end integer between 64512 and 65534 65534 }] as_spine_range [{ Array of object: AS (autonoumus system) number for the switches.
PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3} (25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?) Address part of the subnet in the CIDR notation prefix_len* integer between 1 and DEFAULT:16 32 Mask part of the subnet in the CIDR notation } loopback_seed_address { Loopback subnet seed address which will be used to configure the loopback addresses on the switches. address string DEFAULT:10.10.10.1 PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.
} enable_edge_bfd BFD state for edge connections boolean } } BGP_EVPN { Base model holding interlink address, loopback seed and BGP configurations for an L3 Fabric vtep_seed_address { The seed address for VxLAN Tunnel EndPoints. address string PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.
} bfd { BFD settings for the fabric fabric_bfd_parameters { Parameters of a BFD session. At this time, the parameters are read-only. interval integer between 100 and DEFAULT:200 min_rx integer between 100 and DEFAULT:200 1000 Hello packets transmission interval in milliseconds 1000 minimum receive interval for Hello packets in milliseconds multiplier integer between 1 and DEFAULT:3 50 Number of Hello packets miss that can be tolerated } edge_bfd_parameters { Parameters of a BFD session.
new_object_id id string string This represents the id of the new object created for the POST API call. message messageParams string [string] Success or error message This represents the key for the localized property file to be used by UI to show the localized string. Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *fabric-intent-id string Unique identifier of the fabric intent *interlink-id Unique identifier of the interlink object string RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
15. LIFE CYCLE MANAGEMENT 15.1 GET /lcm/update-jobs API to get all switch image update jobs This api will return all the switch image update jobs present in the system REQUEST No request parameters RESPONSE STATUS CODE - 200: Response to get all switch image update jobs RESPONSE MODEL - application/json { This object represent the list of switch image server update jobs. data [{ Array of object: id name description job_type string string string enum unique ID of this switch image update job.
}] extended_path string Optional path, if specified, will be appended to the image source URL. } STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
15.2 POST /lcm/update-jobs API to create a new job to update switch image. REQUEST REQUEST BODY - application/json { Name and description ref object image_server_oid* switch_group_oid* os_image_version* image_file_name* extended_path name* string string string string string string description string The image server object id that has the details to download the image. Id of the switch / switch group whose image need to be updated. OS image version that will be installed on the switches.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
Whether the job is to be scheduled or executed now. This will be popluated once the job is deployed. scheduled_at integer Time in the future that this job needs to be executed, if scheduled, represented in seconds since epoch. This will be popluated once the job is deployed. os_image_version string image_file_name string job_state enum OS image version that will be installed on the switches. Filename of the image.
id message messageParams This represents the key for the localized property file to be used by UI to show the localized string. string string [string] Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string.
STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 15.6 POST /lcm/update-jobs/{id}/approval-request API to request approval for a switch image update job. Request approval for a switch image update job represented by the requested 'id'. The job has to be in approved state to deploy.
} STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
15.7 POST /lcm/update-jobs/{id}/cancel API to cancel a job that is scheduled to deploy API to cancel a job that is scheduled to deploy. The cancelled job will return back to Approved state. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *id string Unique identifier of the switch image update job.
messageParams [string] Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
messageParams [string] Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
VALIDATION_IN_PROGRESS, VALIDATION_FAILED, EXTRACTION_IN_PROGRESS, EXTRACTION_FAILED, TRANSFER_FAILED, SUCCESS file_transfer_status { Details of the file transfer process. } progress_percentage start_time end_time file_size transfer_rate message integer integer integer integer integer string start time in seconds since epoch. end time in seconds since epoch. Size of the file in bytes. file transfer rate in kbps Free form text message from switch.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
16. METRICS Time series based metrics. 16.1 POST /metrics Gets metric time series within a time range. Fetches individual set of metric time series or multiple sets of time series. Omit any optional parameters which are not used. To retrieve single/multiple set(s) of time series for a single entity provide entity_id. To retrieve single/multiple set(s) of time series for multiple related entities omit entity_id and provide a tag which applies to all the time series.
Multiple time series for any entity which share metric_name and switch_id. In this example it is a in_pkts time series for all interfaces of switch "2:222222". Example 5 - Retrieving the Latest Metric Point per Time Series: To fetch the latest metric value for any of the examples above use current time, as a unix timestamp, for both start_time_unix and end_time_unix. *Result*: One metric point for each timeseries. Optionally filters time series results by rank.
tags [{ Array of object: key string value string }] timeseries [{ Array of object: Metric points returned from metrics store. timestamp integer value number }] Unix timestamp of metric value. Value of the metric point. }] } STATUS CODE - 400: Invalid request. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 16.2 POST /metrics/aggregation Gets aggregated metric time series. Fetches metric time series aggregation by tag.
* 1 day - 1 week -> 1 hour * 1 week - 1 month -> 3 hours * 1 month + -> 1 day Note: these default intervals are inputted in seconds. Used mins/hours/days terminology in description only. entity_id function_name string enum Unique identifier of the entity. ALLOWED:RATE, MAX_OVER_TIME, AVG_OVER_TIME Enum for supported metric function to apply to metrics data. E.g. 'rate()' function. RATE is recommended to only be used for counters. Can only be used if a time range is provided.
id string message string field_name string messageParams [string] } This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation.
interface_health{switch_oid = "2:222222", object_id = "11:222222", role = "vlt"} Metric interface_health value can range from 0 to 100. Example: Retrieve distribution of interface_health for all interfaces on switch 2:222222 by role at 9:00AM on 04/03/2020.
REQUEST REQUEST BODY - application/json { metric_name* string distribution_by* string timestamp_unix* integer buckets [{ Name of metric which will be used to determine distribution by buckets. Name of tag which comprises distributions. Timestamp at which metric_name's value will be distributed by according to distribution_by. Array of object: bucket_name string start_value integer end_value integer Name of bucket. Starting value of bucket. Ending value of bucket.
} STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
17. MULTI-TENANCY APIs for Tenants and VxLAN segments, in a fabric intent. 17.1 GET /fabric-intents/{fabric-intent-id}/tenants Details of all the tenants using the fabric. This API will list all the tenants that are using the fabric managed by SFD. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *fabric-intent-id string Unique identifier of the fabric intent RESPONSE STATUS CODE - 200: Response to get a list of all tenants using the fabric.
} }] STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
vm_manager_id string irb-type enum The VM manager this Tenant is associated to. ALLOWED:SYMMETRIC, ASYMMETRIC The distributed routing type:SYMMETRIC/ASYMMETRIC. name* description string string Name of the tenant Optional description for the tenant. } RESPONSE STATUS CODE - 201: success or error response RESPONSE MODEL - application/json { new_object_id id string string This represents the id of the new object created for the POST API call.
Array of object: id string This represents the key for the localized property file to be used by UI to show the localized string. message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
name string Name of the VM manager. } name* description string string Name of the tenant Optional description for the tenant. } STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
} }] 17.4 PUT /fabric-intents/{fabric-intent-id}/tenants/{id} Updates a tenant by ID. This API will be used to update properties of an existing tenant. This can only be used if the fabric-intent on which the tenant is defined, is in DRAFT state. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *fabric-intent-id string Unique identifier of the fabric intent *id Unique identifier of the tenant. string REQUEST BODY - application/json { Represents a tenant using the fabric.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 404: Requested entity does not exist.
NAME TYPE DESCRIPTION *fabric-intent-id string Unique identifier of the fabric intent *id Unique identifier of the tenant. string RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
messageParams [string] } Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
RESPONSE STATUS CODE - 200: Response to get a list of VxLAN Segments. RESPONSE MODEL - application/json { List of VxLAN segments. data [{ Array of object: Represents a VxLAN Segment for a tenant id tenant-id tenant_name fabric-intent-id string string string string vni* integer between 1 and Unique identifier of the VxLAN segment Unique identifier of the tenant whom this segment belongs to. Name of the tenant whom this segment belongs to.
The vlan-id on each rack, which this segment stretches on to. }] description } string An optional description for the VxLAN segment. }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
} 17.7 POST /fabric-intents/{fabric-intent-id}/tenants/{tenant-id}/vxlansegments Add a VxLAN segment for a Tenant This API will be used to create a VxLAN Segment for a tenant. A VxLAN Segment defines a stretch across multiple leafpairs, where overlay L2 connectivity will be provided using VxLAN tunnelling, on a L3 fabric. Each VxLAN segment will be identified by a unique l2-vni, that will be used to send encapsulated packets between hosts in the same segment.
2[0-4][0-9]|[01]?[0-9][0-9]?)(\/([0-9]|[1-2][0-9]|3[0-2])) vtep_ip string SVI interface IP for leaf switch-2 in CIDR notation PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]| 2[0-4][0-9]|[01]?[0-9][0-9]?)(\/([0-9]|[1-2][0-9]|3[0-2])) vlan_id* VTEP interface IP on leaf-rack in CIDR notation integer between 2 and 4094 The vlan-id on each rack, which this segment stretches on to. }] description string An optional description for the VxLAN segment.
string. message messageParams string [string] Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id string This represents the key for the localized property file to be used by UI to show the localized string. message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message.
data [{ Array of object: Represents a VxLAN Segment for a tenant id tenant-id tenant_name fabric-intent-id string string string string vni* integer between 1 and static_anycast_gateway_ip_address* string Unique identifier of the VxLAN segment Unique identifier of the tenant whom this segment belongs to. Name of the tenant whom this segment belongs to. Unique identifier of the fabric intent that defines the fabric configuration used by the tenant.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
Gets details of a VxLAN Segment by ID.
(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/([0-9]|[1-2] [0-9]|3[0-2])) SVI interface IP for leaf switch-1 in CIDR notation svi_ip_2* string vtep_ip string PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3} (25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/([0-9]|[1-2] [0-9]|3[0-2])) SVI interface IP for leaf switch-2 in CIDR notation PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3} (25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/([0-9]|[1-2] [0-9]|3[0-2])) VTEP interface IP on leaf-rack in CIDR notation vlan
id message messageParams This represents the key for the localized property file to be used by UI to show the localized string. string string [string] Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string.
The user will input one SVI IP for each leaf in the pair. The static anycast gateway IP will be common for every leaf-pair part of the VxLAN Segment, and hence it will not be a switch-pair property. It will be defined as a VxLAN Segment property. switch_id_1 switch_1_name switch_id_2 switch_2_name svi_ip_1* string string string string string svi_ip_2* string Unique identifier of switch-1 in the leaf pair. Name of switch-1 in the leaf pair. Unique identifier of switch-2 in the leaf pair.
the Message in the localized file. } }] STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
18. NFC ACTIVITIES Activities in the NFC. 18.1 GET /activities Retrieves the NFC Activities NFC Activity is summary of operations happening in the NFC. This could be operator driven or any dynamic activity happening in the NFC. This API returns the NFC Activities. REQUEST QUERY PARAMETERS NAME TYPE DESCRIPTION start-time int64 Get all the NFC activities created after start timestamp(inclusive). The default value for start timestamp is set as (end-time - 24 hours).
HOST_LINK_ADD, HOST_LINK_REMOVE, LCM_IMAGE_UPDATE, CONFIG_REPLAY, CREATE_BACKUP start_time end_time status integer integer enum Sub - Type of activity Start time of the main job End time of the main job ALLOWED:UNAVAILABLE, SUCCESS, IN_PROGRESS, PARTIAL_SUCCESS, FAILED Status of the main job.
id message messageParams string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string.
19. NOTIFICATION-SERVICE Notification Service APIs 19.1 GET /notifications Retrieve all the currently applied notification configurations. This API returns all the currently applied notification configurations.
smtp_host* port* from_email_id* username password auth_required* ssl_required* } string integer string string string boolean boolean SMTP Host Port Email id from which notifications will be sent Username of account Password of account Is authentication required? Is SSL required? } 19.2 GET /notifications/smtp Retrieve the applied SMTP configuration. This API returns the currently applied SMTP configuration.
new_object_id id message messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
} error_message string Error message (in case of failure) STATUS CODE - 400: Invalid request. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
RESPONSE STATUS CODE - 200: Response to a notification request RESPONSE MODEL - application/json { Notification Request Status object status enum ALLOWED:SUCCESS, FAILURE Status of the request } error_message string Error message (in case of failure) STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
19.5 POST /notifications/smtp/test Send a test email This API sends a test email based on input data.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
20. SWITCH INFORMATION 20.1 GET /switches/summary get summary of all switch REQUEST No request parameters RESPONSE STATUS CODE - 200: list of switch summary RESPONSE MODEL - application/json { This object represent the list of switch summary.
Message in the localized file. } }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
id name service_tag model os_version status { string string string string string Unique identifier of the switch object name of the switch service tag of switch model of the switch os version of the switch "Describes the state of switch in the topology. If the switch is discovered, reachable etc" switch_state enum ALLOWED:DEFINED, MAINTENANCE, REACHABLE, PROVISIONED, ACTIVE, ERROR, UNMANAGED, REBOOT_IN_PROGRESS The current state of the switch.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
admin_status enum ALLOWED:UP, DOWN, PENDING, UNDEFINED state of interface. members [{ Array of object: The information about an Ethernet interface. id name switch_id switch_name string string string string The object id of the interface. the name of the interface. Oid of the switch, on which the interface resides. Name of the switch, on which the interface resides. }] } STATUS CODE - 401: You are not authorized to perform this operation.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } 20.4 GET /switches/{switch-id}/interfaces/{interface-id}/bfd Get bfd information of port channel.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 404: Requested entity does not exist.
NAME TYPE DESCRIPTION *interface-id string Unique identifier of the interface. RESPONSE STATUS CODE - 200: interface information response. RESPONSE MODEL - application/json { Interface information interface_id name role string string enum interface_type enum interface id interface name ALLOWED:MANAGEMENT, EDGELINK, HOSTLINK, VLTLINK, INTERLINK, LOOPBACK, UNDEFINED, NOT_APPLICABLE Describes the type of connection from one interface to another.
Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
name role string enum interface_type enum operational_status enum interface name ALLOWED:MANAGEMENT, EDGELINK, HOSTLINK, VLTLINK, INTERLINK, LOOPBACK, UNDEFINED, NOT_APPLICABLE Describes the type of connection from one interface to another. ALLOWED:ETHERNET, LOOPBACK, ROUTED_VLAN, AGGREGATION, UNDEFINED Describes the type of interface ALLOWED:UP, DOWN, PENDING, UNDEFINED state of interface. admin_status enum ALLOWED:UP, DOWN, PENDING, UNDEFINED state of interface.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
streaming_status enum ALLOWED:UNKNOWN, CONNECTED, DISCONNECTED, CLOSED interface_count bgp_peers_count cpu_utilization memory_utilization host_count vtep_ip integer integer number number integer string number of interface in UP state. vni_count integer number of VNI's in the switch. telmetry connection status of switch } number of BGP neighbor in CONNECTED state. cpu utilization of the switch in percentage. memory utilization of the switch in percentage. number of connected host to the switch.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 20.8 GET /switches/{switch-id}/bgp-neighbors Get bgp neighbors of a switch .
route to be used by the system's RIB } }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
21. SWITCH MANIFEST External Manifest file APIs 21.1 PUT /switch-manifest/ Uploads the external manifest file. Switch Manifest file has the list of supported models and software versions for a SFD version. This api uploads the external switch Manifest file. This will override the current one in SFD. There is going to be only one switch manifest file in the SFD. In response an object id will be returned which can be used to apply this manifest file.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
messageParams [string] } Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 21.2 GET /switch-manifest/support-matrix Get the supported switch matrix This API returns the supported switch model, os-version and os-type etc. REQUEST No request parameters RESPONSE STATUS CODE - 200: response to the switch support matrix RESPONSE MODEL - application/json { List of supported switches with model, os version and os type.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } STATUS CODE - 401: You are not authorized to perform this operation.
22. SWITCH OPERATIONS 22.1 POST /switches/{switch-id}/reboot reboot a switch REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *switch-id string switch oid RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *switch-id string Unique identifier of the switch. *interface-id string Unique identifier of the interface. REQUEST BODY - application/json { Administrative status of an interface. admin_status* enum ALLOWED:ADMIN_UP, ADMIN_DOWN administrative status of an interface.
new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
23. SWITCH-GROUP Switch Group is a logical collection of the switches. 23.
Message in the localized file. } }] STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
STATUS CODE - 201: New entity created successfully. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
API to get a switch group represented by the requested 'id'. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *id string Unique identifier of the switch group RESPONSE STATUS CODE - 200: Resposne to get switch-group by ID RESPONSE MODEL - application/json { id name description switch_members [{ string string string unique ID of this switch-group name of this switch group description of the switch group Array of object: Member of a switch group.
id message messageParams string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 404: Requested entity does not exist. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
STATUS CODE - 200: response to the switch support matrix RESPONSE MODEL - application/json { Supported switch OS version and filename information. The image file details will be those that are common to all the switches in the group.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
24. SYSLOG Syslog messages received by NFC from switches 24.1 GET /syslogs/messages Get Syslog Messages between start and end timestamp Get all syslog messages between start and end timestamp REQUEST QUERY PARAMETERS NAME TYPE DESCRIPTION oid string Object ID, if exists, acts as a filter start-time int64 Start timestamp in epoch ms. The default value for start timestamp is set as (end-time 24 hours) end-time int64 End timestamp in epoch ms.
messageParams [string] } Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
25. SYSTEM System APIs 25.1 GET /system/health Get overall SFD health. This API should be invoked to get the overall system health. REQUEST QUERY PARAMETERS NAME TYPE DESCRIPTION exclusions array of string ALLOWED: NGINX excluded service name when computing system health RESPONSE STATUS CODE - 200: Response for getting system health.
Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } 25.2 POST /system/ping Ping REST Service. This API pings the rest service.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 25.3 POST /system/license-file Upload the SFD license file. License file is obtained from Dell Digital Locker, downloaded into local machine, and then upload into SFD.
STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
} Current version of SFD. version string STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
26. SYSTEM-SETTINGS SFD system settings 26.1 GET /system-settings Returns list of SFD system settings. This API returns list of SFD system settings.
Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 26.2 PUT /system-settings/gateway Configure default gateway in SFD.
field_name string messageParams [string] }] Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 26.5 POST /system-settings/dns Configure DNS server in SFD. This API should be invoked to configure DNS server.
STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
messageParams [string] Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
27. TELEMETRY Time series based metrics and state infomation 27.1 GET /telemetry/catalog Get supported observed variables. Catalog to get all supported observed state and metric variables for telemetry.
Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 400: Invalid request.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
28. TOPOLOGY Physical Topology of the fabric 28.1 GET /topology/status Overall status of the fabric Fabric creation involves design of topology, discovery of physical switches and configuration of the switches. This api can be invoked any time to know the status of the fabric. This will provide status of the each step in creation of the fabric.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
}] messageParams [string] Message in the localized file. } STATUS CODE - 400: Invalid request - uploaded file is not valid RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message.
28.3 GET /topology Returns the physical topoplogy of the fabric This describes the topoplogy of the fabric. It also tells if the switches are discovered or not. REQUEST QUERY PARAMETERS NAME TYPE edge-cloud boolean DESCRIPTION If this parameter is false then edge cloud and edge cloud conenctions will not be returned.
speed string state enum Describes the speed on the physical port ALLOWED:NONE, OPERATIONAL, DEGRADED, DOWN Describes the operation state of the entity. It can take different values depending upon the running state of the entity.
id message field_name messageParams }] string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
29. UPGRADE Upgrade APIs related to SFD upgrades 29.1 POST /upgrades/local-file Upload upgrade file from local host REQUEST FORM DATA PARAMETERS NAME TYPE DESCRIPTION upgradeFile string(binary) the local upgrade file to be uploaded RESPONSE STATUS CODE - 201: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
message messageParams Success or error message string [string] Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
requirement error_message string string }] } message string acknowledged_by string acknowledged_at integer initiated_by start_at completed_at error string integer integer enum Describes the upgrade requirement Detailed message describing pre-check failure Current status information or error message of upgrade progress. User id of NFC operator who previously have acknowledged this upgrade. The time in seconds since epoch at which this upgrade was acknowledged by NFC operator.
field_name string messageParams [string] }] Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. } STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
on this job. The Switch will be in unmanaged state if the this switch is not supported by SFD based on SFD manifest file. The switch can be in ERROR state becuase of various reasons. Like not reachable, auth failure, config errors etc. error_detail enum ALLOWED:NONE, CREDENTIAL_FAIL, UNREACHABLE, CONFIG_ERROR, NOT_OPERATIONAL If the switch state is in error then this enum tells the reason for that error.
messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] 29.5 GET /upgrades/latest Get latest upgrade details.
field is empty if the acknowledge is in FALSE state. initiated_by start_at completed_at error string integer integer enum name of user who initiated this upgrade. Time of upgrade start. The timestamp is defined in epoch milliseconds. Time of upgrade completion. The timestamp is defined in epoch milliseconds.
29.6 POST /upgrades/latest Perform specified action on latest upgrade REQUEST QUERY PARAMETERS NAME TYPE DESCRIPTION *actio n enum Action to perform on the upgrade. pre-check, init and ack operations needs to be performed in-order. ACK will fail if called before INIT and INIT will fail if called before PRE-CHECK. ALLOWED: PRE_CHECK, INIT, ACK RESPONSE STATUS CODE - 201: Response to upload upgrade file RESPONSE MODEL - application/json { The detailed information of whole upgrade progress.
error enum ALLOWED:UNSET, REMOTE_SERVER_INVALID_PROTOCOL, REMOTE_SERVER_FAILED_TO_CONNECT, REMOTE_SERVER_INVALID_CREDENTIALS, REMOTE_SERVER_HOST_UNREACHABLE, REMOTE_SERVER_IO_ERROR, REMOTE_SERVER_REMOTE_DIR_NOT_PRESENT, REMOTE_SERVER_REMOTE_FILE_NOT_PRESENT, REMOTE_SERVER_FAILED_TO_DOWNLOAD_FILE, REMOTE_SERVER_FAILED_TO_UPLOAD_FILE, REMOTE_SERVER_FAILED_TO_LIST_FILES_ON_REMOTE_PATH, UPGRADE_ALREADY_IN_PROGRESS, LOCAL_BUNDLE_NOT_PRESENT, INVALID_UPGRADE_ID, INTERNAL_SERVER_ERROR, LATEST_UPGRADE_RECORD_NOT
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams }] string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
30. VM-MANAGER vCenter and NSX access APIs 30.1 GET /vm-managers Returns all the vCenters and NSX managed by SFD. This api returns all the vm-managers monitored by SFD.
STATUS CODE - default: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
messageParams [string] } Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
RESPONSE MODEL - application/json { Nfc vCenter/NSX Object id name type string string enum Unique identifier of the nfc vCenter/NSX object Name of the vCenter/NSX VM Manager. ALLOWED:VCENTER, NSX Type of the Vm-manager. Currently vCenter and NSX are supported. url string description string username string tenants [{ URL of VM manager description of VM Manager VM Manager username Array of object: Tenant info object tenant_id string tenant_name string }] state enum Unique identifier of the tenant.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
} }] 30.5 DELETE /vm-managers/{id} Delete a vm-manager By Id This api deletes a vCenter/NSX by id. REQUEST PATH PARAMETERS NAME TYPE DESCRIPTION *id string Unique identifier of the vCenter/NSX RESPONSE STATUS CODE - 200: success or error response RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
{ new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
31. WIRING DIAGRAM Wiring diagram builder for the fabric. 31.1 POST /wiring-diagrams Uploads the physical wiring diagram file in JSON format. Upload the fabric design file in JSON format. The Wiring diagram is colllection of Leaf and Spine switches and connections between them. Multiple wiring diagrams can be uploaded.
message messageParams string [string] messages [{ Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. Array of object: id message field_name messageParams string string string [string] }] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message.
message string field_name string messageParams [string] } Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call.
} }] 31.
type role enum ALLOWED:ETHERNET, LOOPBACK, ROUTED_VLAN, AGGREGATION, UNDEFINED Describes the type of interface enum ALLOWED:MANAGEMENT, EDGELINK, HOSTLINK, VLTLINK, INTERLINK, LOOPBACK, UNDEFINED, NOT_APPLICABLE speed string state enum Describes the type of connection from one interface to another. Describes the speed on the physical port ALLOWED:NONE, OPERATIONAL, DEGRADED, DOWN Describes the operation state of the entity.
id message messageParams This represents the key for the localized property file to be used by UI to show the localized string. string string [string] Success or error message Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file. messages [{ Array of object: id message field_name messageParams string string string [string] This represents the key for the localized property file to be used by UI to show the localized string.
Message in the localized file. messages [{ Array of object: id message field_name messageParams } string string string [string] This represents the key for the localized property file to be used by UI to show the localized string. Success or error message Field name where the error was seen Params array to substitute in the message. This will be used by UI to substitue the params in the Message in the localized file.
status enum ALLOWED:DRAFT, PENDING_APPROVAL, APPROVED, DEPLOY_IN_PROGRESS, ACTIVE, INACTIVE States of fabric intent. } }] STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] This represents the id of the new object created for the POST API call. This represents the key for the localized property file to be used by UI to show the localized string.
switch_models [{ Array of object: Switch model and image file name. model string image_files [string] } }] image_files [string] Name of switch model. image file name for this model. The image filename which is supported for all switch models. STATUS CODE - 401: You are not authorized to perform this operation. RESPONSE MODEL - application/json { new_object_id id message messageParams string string string [string] messages [{ This represents the id of the new object created for the POST API call.
of 340
