View device parameter templates

Gets the brand parameters template for the specified device.

Use this request as a utility to view the relevant parameters per brand before adding or editing device using the /api/v1/devices/ request. For more details, see Add/Edit a device.

Resource Name: /api/v1/devices/examples/<brandName>

Request Method:

GET

Request URL Parameters:

Parameter

Required

Type

Description
brandName

Mandatory

String

Brand name of the required device as follows:

aws, azure, ciscoaci, ciscoise, ios, nexus, cma, pv1, f5bigip_afm, file, firepower, fortigate, fortimanager, junos, nsc, space_security_director, nsx, paloalto, panorama

requiredOnly

Optional

Boolean

True - Returns only mandatory parameters

False - Returns both mandatory and optional parameters

Response:

Code

Description
200

OK. Returns the requested data as specified in JSON format.

400

Bad request

401

Unauthorized

Request example

curl --location --request GET 'https://docker:7443/afa/api/v1/devices/e xamples/nsc' \ --header 'Content-Type: application/json' \ --header 'Accept: */*' \ --header 'Cookie: PHPSESSID=r9psihhnjebng2oovhv268odh1'

Response example

{ "collect_log_from": "nsm", "ssh_port": "", "con": "SSH", "FW_TYPE": "FW_NSC", "log_passwd": "<syslog-server-password>", "user_name": "<user-name>", "log_collection_mode": "extensive", "active_change": "yes", "log_user_name": "<syslog-server-user-name>", "log_host_name": "<syslog-server-host-name>", "monitoring": "no", "display_name": "<display-name>", "log_user_name_adt": "<auditing-server-user-name>", "collector": "Central Manager", "log_passwd_adt": "<auditing-server-password>", "collect_log": "yes", "passwd": "<password>", "vrouters": "yes", "baseline_profile": "JuniperNetscreenProfile", "name": "<unique name set by AFA, relevant only for 'EDIT'>", "log_host_name_adt": "<auditing-server-host-name>", "collect_log_from_adt": "nsm", "host_name": "<host-name>", "log_collection_frequency": "60", "additional_fw_ids": "" }