Add/Edit a device

Adds a device to AFA, or edits the device configuration for a device already managed by AFA.

Note: For information to be used in this API for devices managed by management devices , see Get device info about managed devices.

Resource details

Resource Name:

/api/v1/devices/

Request Methods:

POST - adds a device
PUT - edits a device

Request URL Parameters:

Parameter	Required	Type	Description
body	Mandatory	String	Data in JSON format that specifies the values for all parameters applicable to the brand of the added or edited device. For more details, see Request parameters by brand.
addChildren	Optional	Boolean	True - managed devices are automatically added. (Default) False - managed devices are not added unless specified explicitly.
testMode	Optional	Boolean	True - used as a test run without actually adding or editing the device specified. Returns all parameters that would have been sent by the request. False (default) - performs the actual request.

Parameter

Required

Type

Description

body

Mandatory

String

Data in JSON format that specifies the values for all parameters applicable to the brand of the added or edited device.

For more details, see Request parameters by brand.

addChildren

Optional

Boolean

True - managed devices are automatically added. (Default)

False - managed devices are not added unless specified explicitly.

testMode

Optional

Boolean

True - used as a test run without actually adding or editing the device specified. Returns all parameters that would have been sent by the request.

False (default) - performs the actual request.

Response:

Code	Description
200	Operation completed successfully
400	Bad request, with one of the following error messages: ALREADY_EXISTS. Specified device not found in AFA. SCHEME_ERROR. Failed to load the device schema. Validation Error. API values are not valid according to the device schema. Not Found. Relevant when editing a device configuration, if the specified device is not found in AFA.
401	Unauthorized
403	Non-admin user

Add device - Request example (Add FortiManager with specific Firewalls)

curl --insecure "https://localhost/afa/api/v1/devices?addChildren=false" --request POST \\
				-H "Content-Type: application/json" \
				-H "Cookie: PHPSESSID=et52j33f796dl86pt7ms7efq29" \
			-d '{"brand": "fortimanager","host_name": "10.23.30.200","user_name": "fmgr_admin","passwd": "algosec","rest_port":"3443","log_collection_mode":"none","arrFWs": [{"FWName": "FW1_root","FWParent": "FW1"}]}'

Edit device - Request example a (Edit FortiManager that was already added)

curl --insecure "https://localhost/afa/api/v1/devices?addChildren=true" --request PUT \
				-H "accept: */*" \
				-H "Content-Type: application/json" \
				-H "Cookie: PHPSESSID=et52j33f796dl86pt7ms7efq29" \
			-d '{"name":"10.23.30.200","brand": "fortimanager","arrFWs": [{"FWName": "FW1","FWDefined":"false"},{"FWName": "root","FWDefined":"true"}]}'

Edit device- Request example b

curl --location --request PUT 'https://docker:7443/afa/api/v1/devices/' \ --header 'Content-Type: application/json' \ --header 'Accept: */*' \ --header 'Cookie: PHPSESSID=r9psihhnjebng2oovhv268odh1' \ --data-raw '{ "display_name": "myUpdatedNSC", "name": "fw_10_20_13_1", "host_name": "10.20.13.1", "user_name": "admin", "passwd": "algosec", "collector": "Central Manager", "baseline_profile": "JuniperNetscreenProfile", "vrouters": "yes", "con": "SSH", "ssh_port": "", "log_collection_mode": "extensive", "collect_log": "yes", "collect_log_from": "nsm", "log_host_name": "10.0.0.2", "log_user_name": "root", "log_passwd": "algosec", "collct_log_from_adt": "nsm", "log_host_name_adt": "10.0.0.1", "log_user_name_adt": "root", "log_passwd_adt": "algosec", "additional_fw_ids": "1.1.1.1:2.2.2.2:ServerName", "log_collection_frequency": "20", "active_change": "yes", "monitoring": "no", "set_user_permissions": "no", "password_fields": "passwd:log_passwd:log_passwd_adt", "FW_TYPE": "FW_NSC"

Edit device - Response example (Edit FortiManager that was already added)

{
				"httpStatus": "200",
				"message": "Successfully modified \"myUpdatedNSC\"",
				"LogData": "",
				"fw_name": "fw_10_20_13_1",
				"syslog_restart_needed": false,
				"not_supported_audit_from_clm": false,
				"set_user_permissions": false
			}

Request parameters by brand

The following tables list the parameters valid for each brand recognized by AFA. In the tables, click each parameter name to jump to more details.

Amazon Web Services (AWS) EC2

Required	Parameter
Mandatory	aws_access_key_id aws_secret_access_key aws_specific_region brand host_name name (mandatory only when editing)
Optional	active_change aws_assume_role aws_resource_name monitoring

Arista

Required	Parameter
Mandatory	brand name user_name passwd epasswd selected_devices
Optional	collector display_name monitoring fetched_devices - array of managed devices. For a list of parameters for managed devices, see Arista managed device parameters.

Arista managed device parameters

Required	Parameter
Mandatory	fetched_devices/host_name
Optional	fetched_devices/log_collection_mode

Azure

Required	Parameter
Mandatory	azure_client_id azure_client_key azure_subscription_id azure_tenant_id brand host_name name
Optional	monitoring route_collection

Check Point Provider 1

For managed devices parameters, see Check Point Provider 1 managed device parameters.

Required	Parameter
Mandatory	CKP_R80_or_higher CMA CMA_HOST FW_TYPE MS_passwd name SelectedCMA
Optional	active_change Allow_Auto_Implementation arrFW - Array of managed devices. For a list of parameters for managed devices, see Check Point Provider 1 managed device parameters. Add/Edit a device collector communication display_name log_collection_frequency monitoring MS_epasswd MS_host_name MS_os MS_user_name ssh_port

Check Point Provider 1 managed device parameters

Required	Parameter
Mandatory	FW_NAME LOGSERVER
Optional	do_log_analysis FW_baseline_profile FW_display_name FW_epasswd FW_host_name FW_os FW_passwd FW_user_name IS_ENABLED log_collection_mode RM_NAME

Check Point Smart Center

Required	Parameter
Mandatory	CKP_R80_or_higher FW_TYPE MS_epasswd MS_host_name MS_passwd MS_user_name
Optional	active_change Allow_Auto_Implementation arrFW - array of managed devices. For a list of parameters for managed devices, see Check Point Smart Center managed devices parameters. collector communication display_name log_collection_frequency monitoring MS_os ssh_port

Check Point Smart Center managed devices parameters

Required	Parameter
Mandatory	FW_display_name FW_NAME LOGSERVER
Optional	do_log_analysis FW_baseline_profile FW_epasswd FW_host_name FW_os FW_passwd FW_user_name IS_ENABLED log_collection_mode RM_NAME

Cisco Application Centric Infrastructure (ACI)

Required	Parameter
Mandatory	brand host_name name passwd user_name
Optional	active_change collector display_name monitoring route_collection static_urt_filename use_cyberark cyberark_platform cyberark_safe cyberark_folder cyberark_object

Cisco ASA

Required	Parameter
Mandatory	epasswd FW_TYPE name passwd user_name
Optional	additional_fw_ids baseline_profile collect_log collect_log_from collector con use_cyberark cyberark_platform cyberark_safe cyberark_folder cyberark_object cyberark_enable_platform cyberark_enable_safe cyberark_enable_folder cyberark_enable_object display_name GenerateACL host_name log_collection_frequency log_collection_mode log_host_name log_passwd log_user_name monitoring number_of_allowed_encryption_keys route_collection rules_view ssh_port static_urt_filename

Required

Parameter

Mandatory

epasswd
FW_TYPE
name
passwd
user_name

Optional

additional_fw_ids
baseline_profile
collect_log
collect_log_from
collector
con
use_cyberark
cyberark_platform
cyberark_safe
cyberark_folder
cyberark_object
cyberark_enable_platform
cyberark_enable_safe
cyberark_enable_folder
cyberark_enable_object
display_name
GenerateACL
host_name
log_collection_frequency
log_collection_mode
log_host_name
log_passwd
log_user_name
monitoring
number_of_allowed_encryption_keys
route_collection
rules_view
ssh_port
static_urt_filename

Cisco Firepower

Required	Parameter
Mandatory	brand fetched_devices - array of managed devices. For a list of parameters for managed devices, see Cisco Firepower managed device parameters. name passwd selected_devices user_name
Optional	active_change collector display_name host_name monitoring

Cisco Firepower managed device parameters

Required	Parameter
Mandatory	fetched_device/host-name fetched_devices/FW_host_name * fetched_devices/FW_passwd * fetched_devices/FW_user_name *
Optional	fetched_devices/FW_baseline_profile fetched_devices/log_collection_mode fetched_devices/RM_NAME

Note: Starred parameters are technically listed as optional. However, adding a Firepower device without it's childrens' credentials will cause analysis to fail.

Cisco Identity Services Engine (ISE)

Required	Parameter
Mandatory	brand host_name name passwd user_name
Optional	collector display_name monitoring

Cisco IOS

Required	Parameter
Mandatory	enable_user_name epasswd FW_TYPE host_name name passwd user_name
Optional	Auto_Tree_Update_Enabled baseline_profile collector con use_cyberark cyberark_platform cyberark_safe cyberark_folder cyberark_object cyberark_enable_platform cyberark_enable_safe cyberark_enable_folder cyberark_enable_object display_name full_analysis monitoring number_of_allowed_encryption_keys route_collection separate_vrfs ssh_port static_urt_filename

Cisco Meraki

Required	Parameter
Mandatory	host_name authenticationKey (the API key) brand selected_devices
Optional	display_name collector monitoring

Cisco Nexus Router

Required	Parameter
Mandatory	brand collector host_name name passwd user_name
Optional	Auto_Tree_Update_Enabled baseline_profile con use_cyberark cyberark_platform cyberark_safe cyberark_folder cyberark_object display_name full_analysis monitoring number_of_allowed_encryption_keys route_collection separate_vrfs ssh_port static_urt_filename

F5 BIG

Required	Parameter
Mandatory	brand host_name name passwd user_name
Optional	additional_fw_ids baseline_profile collect_log collect_log_from collector use_cyberark cyberark_platform cyberark_safe cyberark_folder cyberark_object display_name log_collection_frequency log_collection_mode log_host_name log_passwd log_user_name monitoring route_collection static_urt_filename

Fortinet Fortigate

Required	Parameter
Mandatory	brand host_name name passwd user_name
Optional	additional_fw_ids baseline_profile collect_log collect_log_from collector con display_name log_collection_frequency log_collection_mode log_host_name log_passwd log_user_name monitoring number_of_allowed_encryption_keys route_collection ssh_port static_urt_filename

Fortimanager

Required	Parameter
Mandatory	brand display_name host_name name passwd user_name
Optional	arrFW - array of managed devices. For a list of parameters for managed devices, see Fortimanager managed devices parameters (part of arrFWs array). collect_log collect_log_from collector con use_cyberark cyberark_platform cyberark_safe cyberark_folder cyberark_object log_collection_frequency log_collection_mode log_host_name log_passwd log_user_name monitoring rest_port

Fortimanager managed devices parameters (part of arrFWs array)

Note: The arrFWs array contains child device details. Must contain two mandatory parameters, FWName and FWParent for each child device. Can contain the following optional parameters from Fortimanager managed devices parameters (part of arrFWs array).

	"arrFWs": [
							{
							"FWName": "<firewall-name>",
							"FWParent": "<firewall-parent-name>"
						},

...

Required	Parameter
Mandatory	FWName FWParent
Optional	FW_baseline_profile FW_display_name FW_host_name FW_passwd FW_user_name FWDefined FWLogAnalysis FWLogCollectMode FWOrigName

Juniper Netscreen

Required	Parameter
Mandatory	FW_TYPE host_name name passwd user_name
Optional	active_change additional_fw_ids baseline_profile collect_log collect_log_from collect_log_from_adt collector con use_cyberark cyberark_platform cyberark_safe cyberark_folder cyberark_object display_name log_collection_frequency log_collection_mode log_host_name log_host_name_adt log_passwd log_passwd_adt log_user_name log_user_name_adt monitoring ssh_port vrouters

Juniper Space

Required	Parameter
Mandatory	brand fetched_devices - array of managed devices. For a list of parameters for managed devices, see Juniper Space managed devices parameters. name passwd selected_devices user_name
Optional	active_change additional_fw_ids collect_log collect_log_from collector use_cyberark cyberark_platform cyberark_safe cyberark_folder cyberark_object display_name host_name log_collection_frequency log_host_name log_passwd log_user_name monitoring

Juniper Space managed devices parameters

Required	Parameter
Mandatory	fetched_devices/FW_host_name
Optional	fetched_devices/FW_host_name fetched_devices/FW_user_name fetched_devices/FW_passwd fetched_devices/FW_baseline_profile log_collection_mode fetched_devices/RM_NAME

Juniper SRX

Required	Parameter
Mandatory	brand host_name name passwd user_name
Optional	additional_fw_ids baseline_profile collect_log collect_log_from collector con display_name log_collection_frequency log_collection_mode log_host_name log_passwd log_user_name monitoring number_of_allowed_encryption_keys route_collection static_urt_filename vrouters

Palo Alto firewall

Required	Parameter
Mandatory	brand host_name name passwd user_name
Optional	additional_fw_ids baseline_profile collect_log collect_log_from collector con display_name log_collection_frequency log_collection_mode log_host_name log_passwd log_user_name monitoring number_of_allowed_encryption_keys route_collection static_urt_filename

Palo Alto Panorama

Required	Parameter
Mandatory	brand host_name passwd selected_devices user_name
Optional	log_host_name active_change collect_log collect_log_from collector use_cyberark cyberark_platform cyberark_safe cyberark_folder cyberark_object fetched_devices - array of managed devices. For a list of parameters for managed devices, see Palo Alto Panorama managed devices parameters. log_collection_frequency log_passwd log_user_name secondary_host_ip

Palo Alto Panorama managed devices parameters

Required	Parameter
Mandatory	fetched_devices/host_name
Optional	fetched_devices/FW_host_name fetched_devices/FW_user_name fetched_devices/FW_passwd fetched_devices/FW_epasswd fetched_devices/FW_baseline_profile fetched_devices/FW_os fetched_devices/log_collection_mode fetched_devices/RM_NAME

Versa Network

Required	Parameter
Mandatory	brand display_name name host_name user_name passwd selected_devices
Optional	monitoring set_user_permissions

VMWare NSX-V

Required	Parameter
Mandatory	brand host_name name passwd user_name
Optional	active_change collector con display_name learning_mode monitoring route_collection separate_vrfs

VMWare NSX-T

Required	Parameter
Mandatory	brand host_name organization_id sddc_id api_token
Optional	active_change collector con display_name learning_mode monitoring route_collection separate_vrfs

Request parameters for device from file

The following table lists parameters for devices created from file.

Device from file

Required	Parameter
Mandatory	existingFile FW_TYPE name
Optional	display_name fileSource monitoring route_collection static_urt_filename

Device parameter details

The following table lists all the parameters used by /api/v1/devices/ GET, POST and PUT methods. All of the listed values are formatted as Strings, unless otherwise indicated.

Click for device parameter details

Note: By default, parameter values for child objects are automatically imported into your REST API call. This functionality is controlled by the addChildren parameter.

Parameter	Description
active_change	Licenses ActiveChange capabilities for the domain. Possible values: yes no (default)
additional_fw_ids	Additional device identifiers. AFA can use multiple IP addresses or hostnames to identify this device when parsing logs, in addition to the default host.
Allow_Auto_Implementation	Possible values: yes no (default)
api_token	Access token for API requests.
do_log_analysis	Configures whether to perform log analysis on child devices in the arrFWs array.
FW_baseline_profile	The default baseline profile for the child device in the array.
FW_display_name	Display name of the child device in the arrFWs array.
FW_epasswd	Password used for advanced mode for the child device in the arrFWs array. Relevant for Cisco routers only.
FW_host_name	Host name of the child device in the arrFWs array.
FW_NAME	Name of the child device in the arrFWs array.
FW_os	Operating system of the child device in the arrFWs array.
FW_passwd	Password to access the child device in the arrFWs array.
FW_user_name	Username to access the child device in the arrFWs array.
FWDefined	Determines whether the child device in the arrFWs array is defined. Possible values: yes no
FWLogAnalysis	Determines whether log analysis is enabled for the child device in the arrFWs array. Possible values: yes no
FWLogCollectMode	The log collection mode defined for the child device in the arrFWs array. Possible values: none standard extensive
FWName	The name of the child device in the arrFWs array. Note: The arrFWs array contains child device details. Must contain two mandatory parameters, FWName and FWParent for each child device. Can contain the following optional parameters from Fortimanager managed devices parameters (part of arrFWs array). "arrFWs": [ { "FWName": "<firewall-name>", "FWParent": "<firewall-parent-name>" }, ...
FWOrigName	The original named as defined in the child device in the arrFWs array.
FWParent	The name of the child device's parent in the arrFWs array.
IS_ENABLED	Determines whether the child device in the arrFWs array is enabled. Possible values: yes no
log_collection_mode	Mode of log collection for iems in the arrFWs array. Possible values: none standard extensive
LOGSERVER	The name of the log server for the child device in the arrFWs array.
RM_NAME	The name of the ASMS system node that collects data for the child device in the arrFWs array. Default value: Central Manager
Auto_Tree_Update_Enabled	Allows monitor to auto update the device tree if new VRFs are found on monitor
aws_access_key_id	AWS access key ID.
aws_assume_role	Set of temporary security credentials you can use to access AWS resources that you might not normally have access to
aws_resource_name	Amazon Resource Name (ARN).
aws_secret_access_key	AWS secret access key.
aws_specific_region	AWS region.
azure_client_id	Azure app client ID (Application ID).
azure_client_key	Client secret key.
azure_subscription_id	GUID that identifies your subscription.
azure_tenant_id	GUID that identifies the Azure Active Directory instance.
baseline_profile	The default baseline profile for the device.
brand	Device brand, for devices that don't have a specific FW_TYPE parameter value. Possible values: aws - Amazon Web Services (AWS) EC2. azure - Azure. pv1 - Check Point Provider 1. cma - Check Point Smart Center. ciscoaci - Cisco Application Centric Infrastructure (ACI). pix - Cisco ASA. firepower - Cisco Firepower. ciscoise - Cisco Identity Services Engine (ISE). ciscomeraki - Cisco Meraki. ios - Cisco IOS. nexus - Cisco Nexus Router. file - Device from file. f5bigip_afm - F5 BIG-IP LTM and AFM. fortigate - Fortinet Fortigate. fortimanager - Fortinet Fortimanager. nsc - Juniper Netscreen. space_security_director - Juniper Space. junos - Juniper SRX. paloalto - Palo Alto firewall. panorama - Palo Alto Panorama. nsx - VMWare NSX. versa_director - Versa Networks
CKP_R80_or_higher	Relevant for Check Point Provider 1 and SmartCenter. Possible values: 1 - device will be connected to CKP Manager R80 or higher. 0 - device will not be connected to CKP Manager R80 or higher.
CMA	Comma-separated list of the Check Point Smart Center names.
CMA_HOST	Comma-separated list of the Check Point Smart Center IP addresses.
collect_log	Enable log collection. Possible values: yes no
collect_log_from	Log server type for traffic logs. Possible values: (blank) - no log collection. syslog - syslog NG Server. nsm - Juniper NSM - relevant only for NetScreen devices.
collect_log_from_adt	Log server type for audit logs. Possible values: (blank) - no log collection. syslog - syslog NG Server. nsm - Juniper NSM - relevant only for NetScreen devices.
collector	Name of the ASMS system node that collects data from the device. Possible values: Central Manager (Default) <name of the collector>
communication	Relevant for all SSH Direct devices. Possible values: cpstat
con	Type of connection. Possible values for most relevant brands: SSH (Default) telnet For Cisco ASA, additional possible values include: SSH(3des) SSH(des) For Fortigate Fortimanager, possible values include only: ssh rest
use_cyberark	Determines whether to use CyberArk authentication: yes no Required for CyberArk devices.
cyberark_platform	Defines the CyberArk platform name. Required for CyberArk devices.
cyberark_safe	Defines the CyberArk safe. Required for CyberArk devices.
cyberark_folder	Defines the CyberArk folder. Required for CyberArk devices.
cyberark_object	Defines the CyberArk object. Required for CyberArk devices.
cyberark_enable_platform	Defines the CyberArk platform for the enable password. Optional, and relevant only for CyberArk devices.
cyberark_enable_safe	Defines the CyberArk safe for the enable password. Optional, and relevant only for CyberArk devices.
cyberark_enable_folder	Defines the CyberArk folder for the enable password. Optional, and relevant only for CyberArk devices.
cyberark_enable_object	Defines the CyberArk object for the enable password. Optional, and relevant only for CyberArk devices.
device_UID	The device's unique ID.*
display_name	Display name of the device.
enable_user_name	Username used for advanced mode. Relevant for Cisco routers only.
epasswd	Password used for advanced mode. Relevant for Cisco routers only.
existingFile	Relevant for Device From File. Enables an existing file in the Algosec file system to be specified as the data source. File must be located in /home/afa/algosec/fwfiles
fetched_devices	The device's children, in a comma-separated list of the fetched_device objects.*
fetched_devices/device_domain	The ID of the fetched device's domain.* Value: 0
fetched_devices/device_group	The ID of the fetched device's group.*
fetched_devices/device_id	The fetched device's ID.*
fetched_devices/device_UID	The fetched device's unique ID.*
fetched_devices/display_name	The fetched device's display name.*
fetched_devices/FW_baseline_profile	The name of the baseline profile associated with the fetched devices.
fetched_devices/FW_epasswd	Password used for advanced mode for the fetched device. Relevant for Cisco routers only.
fetched_devices/FW_host_name	The host name of a fetched device.
fetched_devices/FW_NAME	The fetched device's name.
fetched_devices/FW_os	The fetched device's operating system.
fetched_devices/FW_passwd	The password used to access the fetched device.
fetched_devices/FW_user_name	The username used to access the fetched device.
fetched_devices/host_name	The host name of the fetched device, as defined in the device itself.*
fetched_devices/log_collection_mode	Mode of log collection for the fetched device.* Possible values: none standard extensive
fetched_devices/name	The fetched device's unique name, as defined in AFA.*
fetched_devices/original_name	The original name for the fetched device, as defined in the device itself.*
fetched_devices/RM_NAME	The ASMS system node that collects data from the fetched device. Default value: Central Manager
fetched_devices/serial_num	The fetched device's serial number.*
fetched_devices/syslogIdentifiers	Comma-separated list of the fetched device's syslog servers.*
fileSource	Enables a file to be uploaded to add or edit a device from a file. Possible value: Absolute path to the file you want to upload, including the file name. These files are stored in the /home/afa/algosec/fwfiles/ directory. For example: /home/afa/algosec/fwfiles/myCiscoASA.zip
full_analysis	Enable policy analysis. Possible values: no - default and recommended value for routers with no ACLs. yes
FW_TYPE	Device type, for devices that don't have a brand parameter. Possible values: CMA - Check Point Smart Center FW_FILE - Device from file FW_IOS - Cisco IOS routers FW_NSC - Juniper Netscreen FW_NSM - Juniper NSM FW_PIX - Cisco ASA PV1 - Check Point Multi-Domain Security Management Note: All other devices do not need a specific value for this parameter. Set the brand parameter value instead.
GenerateACL	Determines whether FireFlow can generate CLI recommendations and push them to the device via ActiveChange. Possible values: yes no (Default)
host_name	Host name of the device. Note: For cloud devices: use the name defined for the device in AFA. For Versa Networks: use the Director address.
learning_mode	Determines whether Learning Mode is enabled. Possible values: yes. Learning Mode is enabled. no (Default) Note: Learning Mode marks all traffic from the firewall as blocked, without actually blocking traffic. This enables you to better understand that traffic that flows through the firewall, enabling you to optimize your rules to support your business needs.
log_collection_frequency	Sets how often the log is collected. Value in minutes. Default = 60
log_collection_mode	Mode of log collection for the child device. Possible values: none standard extensive Note: For Cisco firewalls, if only hit-counters are required (and no traffic logs), set to 'none'.
log_host_name	Host name of the traffic log server.
log_host_name_adt	Host name of the ADT Syslog server. Required for configuring a Syslog server for the first time. Default: localhost
log_passwd	Password to connect to the traffic log server.
log_passwd_adt	Password to connect to the audit log server.
log_user_name	Username to connect to the traffic log server.
log_user_name_adt	Username to connect to the audit log server.
monitoring	Sets if the device is monitored. Possible values: yes no (default)
MS_epasswd	Password used for advanced mode for the device.
MS_host_name	Host name of the device.
MS_os	Operating system of the device.
MS_passwd	Password to access the device.
MS_user_name	Username to access the device.
name	Tree name of the device. Relevant only for device edit (PUT). Note: This is not the name displayed in the tree. Get this name using another API. For details, see Get details for a specified device or Get a list of devices.
number_of_allowed_encryption_keys	Relevant for all SSH Direct devices. Controls how many SSH keys are stored for the device to avoid known_host issues. Possible values: unlimited - default 1 2
organization_id	ID of the organization in NSX-T cloud.
original_name	The device's original name, as defined in the device itself.
passwd	Password of user.
rest_port	The device's REST connection port number.
route_collection	The device's routing information collection method. Possible values: automatic (Default) static Note: If you have manually edited the device's routing table, use the static value together with filename of the static URT file. Use this parameter together with the static_urt_filename parameter.
rules_view	Determines the type of rules view used in ASMS. Possible values: CLI ASDM. Use together with the Intelligent Policy Tuner and to display unused objects within rules. Note: ASDM is supported even if you manage the Cisco firewall from the command line.
sddc_id	ID of Software Defined Data Center.
secondary_host_ip	Allows allocation of a secondary IP for the management platform. If the primary IP is not accessible after several attempts, the secondary IP is accessed.
selected_devices	Key and value list of child devices you want to add to AFA. Use a list of a device names with empty key values. For example: "selected_devices": { "Lion_New": {}, "vSRX-Neptune": {}, "vSRX-Uranus": {} } Note: If you are working with a management devices, you must add the child devices even if you are making no changes to those children. Children that are not listed in this value will not be added to AFA.
fetched_device/host-name	The fetched device's host name. Use the APIs listed in Get device info about managed devices to get these values.
SelectedCMA	List of Smart Centers that are managed by MDLM.
separate_vrfs	Determines whether VRF separation is enabled. Relevant for Cisco routers only. Possible values: yes (default and recommended) no
set_user_permissions	Determines whether user permissions are set. Possible values: yes (default and recommended) no
ssh_port	The port used to connect via SSH.
static_urt_filename	The name of the file that contains static routing data. Use this parameter together with the route_collection parameter.
syslog-server-identifier	The ID of the device's syslog server.
user_name	Name of user used to access the device.
vrouters	Determines whether to display virtual routers in the device tree and network map for the device.

Add/Edit a device

Resource details

Request parameters by brand

Request parameters for device from file

Device parameter details

Sorry about that

Great!