NSX-T Data Center REST API

Invoke import task

Invoke import task. There can be only one import task run at any point of
time. Hence invocation of another import task will be discarded, when there
exist an already running import task.

Request:

Method:

POST

URI Path(s):

/policy/api/v1/infra/settings/firewall/import
/policy/api/v1/global-infra/settings/firewall/import
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/import

Request Headers:

n/a

Query Parameters:

ImportRequestParameter+

ImportRequestParameter (schema)

Name	Description	Type	Notes
draft_description	Description to be set on the draft Description to be set on the draft, which will hold the imported configuration.	string
draft_display_name	Display name to be set on the draft Display name to be set on the draft, which will hold the imported configuration.	string	Required Minimum length: 1
file	File to be imported The file having stored firewall configuration. Only zip file will be accepted.	multipart_file	Required
passphrase	Passphrase to verify imported files Passphrase to verify imported files. Passphrase needs to be same as provided earlier to export operation which generated these imported files. The passphrase specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one non-space special character.	secure_string	Required

Request Body:

n/a

Example Request:

POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/import with form-data: "file" = "/exported_fw_configs/fw_config_apr2020.zip" "draft_display_name" = "imported_fw_config_apr2020" "draft_description" = "Import of fw_config_apr2020.zip" "passphrase" = "AA12!@bb"

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ImportTask+

ImportTask (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
async_response_available	True if response for asynchronous request is available	boolean	Readonly
cancelable	True if this task can be canceled	boolean	Readonly
description	Description of the task	string	Readonly
draft_path	Policy path of a draft Policy path of a draft in which the imported configuration gets stored after completion of import task.	string	Readonly
end_time	The end time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
failure_msg	Reason of the task failure This property holds the reason of the task failure, if any.	string	Readonly
id	Identifier for this task	string	Readonly
message	A message describing the disposition of the task	string	Readonly
progress	Task progress if known, from 0 to 100	integer	Readonly Minimum: 0 Maximum: 100
request_method	HTTP request method	string	Readonly
request_uri	URI of the method invocation that spawned this task	string	Readonly
start_time	The start time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
status	Current status of the task	TaskStatus	Readonly
user	Name of the user who created this task	string	Readonly

Example Response:

{ "id": "import_task", "status": "running", "description": "Import of fw_config_apr2020.zip", "draft_path": "/infra/drafts/imported_fw_config_apr2020" "failure_msg": null, "user": "admin", "start_time": 1587491995996 }

Required Permissions:

crud

Feature:

policy_dfw

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable