fortiManager

Access and manage fortiManager objects directly from A-Ops automations.

Actions

fortiManager Connect

Connect to a fortiManager instance. Required before calling any other fortiManager integration objects.

Input

Name	Description	Type	Required	Syntax
Host	IP/DNS location of your fortiManager	input	True	True
Username	Login username	input	True	True
Password	Login password	password-input	True	True
API Protocol	HTTP/HTTPS	input	True	True
ADOM	Which ADOM to use when creating the connection.	input	True	True
Certificate Verify	When HTTPS protocol is used optional to ignore certificate errors.	checkbox	True	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"200": {"description": "Successful."}, "403": {"description": "Failure."}}
fortiManager_connection_id	When successful the index of the created connection is returned.	number	False	{}

---

fortiManager Get ADOMs

List ADOMs present on the fortiManager

Input

Name	Description	Type	Required	Syntax
Connection ID	Optional override for when creating multiple fortiManager connections.	input	True	True

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"200": {"description": "Successful."}, "403": {"description": "No FortiManager connection object found."}}
adoms	When successful a list of adoms is provided.	list	False	{}

---

fortiManager Set ADOM

Change which ADOM is currently being used.

Input

Name	Description	Type	Required	Syntax
Connection ID	Optional override for when creating multiple fortiManager connections.	input	True	True
ADOM	The ADOM to change to.	input	True	True

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"200": {"description": "Successful."}, "403": {"description": "No FortiManager connection object found."}}

---

fortiManager Get Objects

Get a list of object by object type

Input

Name	Description	Type	Required	Syntax
Connection ID	Optional override for when creating multiple fortiManager connections.	input	True	True
Object Type	Object type to return a list of objects	dropdown	True	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"200": {"description": "Successful."}, "403": {"description": "No FortiManager connection object found."}}
objects	When successful a list of objects by selected type.	list	False	{}

---

fortiManager Get Object

Return a given object.

Input

Name	Description	Type	Required	Syntax
Connection ID	Optional override for when creating multiple fortiManager connections.	input	True	True
Object Type	Object type to return a list of objects	dropdown	True	False
Object Name	Name of the object to return	input	True	True

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"200": {"description": "Successful."}, "403": {"description": "No FortiManager connection object found."}}
object	When successful the object and its properties are returned.	json	False	{}

---

fortiManager Set Object

Update a fortiManager object

Input

Name	Description	Type	Required	Syntax
Connection ID	Optional override for when creating multiple fortiManager connections.	input	True	True
Object Type	Object type to return a list of objects	dropdown	True	False
Object Name	Name of the object to return	input	True	True
object Data	JSON data to apply to the object	json-input	True	True

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"200": {"description": "Successful."}, "403": {"description": "No FortiManager connection object found."}}

---