NetApp ONTAP v1.0.0

About the connector

ONTAP helps you create a storage infrastructure that reduces costs, accelerates critical workloads, and protects and secures data across your hybrid multicloud.

This document provides information about the NetApp ONTAP Connector, which facilitates automated interactions, with a NetApp ONTAP server using FortiSOAR™ playbooks. Add the NetApp ONTAP Connector as a step in FortiSOAR™ playbooks and perform automated operations with NetApp ONTAP.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

Use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-netapp-ontap

Prerequisites to configuring the connector

• You must have the URL of the NetApp ONTAP server to which you will connect and perform automated operations and credentials to access that server.
• The FortiSOAR™ server should have outbound connectivity to port 443 on the NetApp ONTAP server.

Minimum Permissions Required

• Not Applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the NetApp ONTAP connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Parameter	Description
Server URL	URL or hostname of the NetApp ONTAP server to connect and perform the automated operations.
Username	Username to access the NetApp ONTAP server to connect and perform the automated operations.
Password	Password used to access the NetApp ONTAP server to connect and perform the automated operations.
Verify SSL	Specifies whether the SSL certificate for the server is to be verified or not. By default, this option is set to True.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

Function	Description	Annotation and Category
Get Security Accounts	Retrieves a list of user accounts in the cluster from NetApp ONTAP based on the fields, maximum count of records, and the sort order you have specified.	get_security_accounts Investigation
Get Security Audit Messages	Retrieves the administrative audit log viewer from NetApp ONTAP based on the timestamp, session ID, and other parameters you have specified.	get_security_audit_messages Investigation
Get Security Roles	get_security_roles Investigation	Retrieves a list of roles configured in the cluster from NetApp ONTAP based on the fields, maximum count of records, and other parameters you have specified.
Update User Password	Updates the password for a user account in NetApp ONTAP based on the username and password you have specified.	update_user_password Investigation

operation: Get Security Accounts

Input parameters

Parameter	Description
Fields	Specify a comma-separated list of fields to return from NetApp ONTAP.
Limit	Specify the maximum count of records to fetch from NetApp ONTAP.
Return Records	Select whether to return the records or just the count of records. The default is true for GET calls. When set to false, only the number of records is sent by NetApp ONTAP.
Return Timeout	Specify, in seconds, the time to wait for the completion of execution. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
Sort Order	Select the sort order of results from the following options: Ascending Descending Default is Ascending.

Output

The output contains the following populated JSON schema:
{
"records": [
{
"owner": {
"_links": {
"self": {
"href": ""
}
},
"name": "",
"uuid": ""
},
"locked": "",
"comment": "",
"_links": {
"self": {
"href": ""
}
},
"name": "",
"applications": [
{
"authentication_methods": [],
"application": "",
"second_authentication_method": ""
}
],
"role": {
"_links": {
"self": {
"href": ""
}
},
"name": ""
},
"scope": ""
}
],
"_links": {
"next": {
"href": ""
},
"self": {
"href": ""
}
},
"num_records": ""
}

operation: Get Security Audit Messages

Input parameters

Parameter	Description
Timestamp	Specify the timestamp of the audit messages to filter the results received from NetApp ONTAP.
State	Specify the state of the audit log to filter the results received from NetApp ONTAP.
Application	Specify the application of the audit log to filter the results received from NetApp ONTAP.
Session ID	Specify the session ID of the audit log to filter the results received from NetApp ONTAP.
Scope	Specify the scope of the audit log to filter the results received from NetApp ONTAP. e.g. svm, cluster.
Command ID	Specify the command ID of the audit log to filter the results received from NetApp ONTAP.
Index	Specify the index of the audit log to filter the results received from NetApp ONTAP.
Location	Specify the location of the audit log to filter the results received from NetApp ONTAP.
Fields	Specify the fields to return from NetApp ONTAP.
Limit	Specify the maximum count of records to receive from NetApp ONTAP.
Return Records	Select whether to return the records or just the count of records. The default is true for GET calls. When set to false, only the number of records is sent by NetApp ONTAP.
Return Timeout	Specify, in seconds, the time to wait for the completion of execution. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
Sort Order	Select the sort order of results from the following options: Ascending Descending Default is Ascending.

Output

The output contains the following populated JSON schema:
{
"records": [
{
"session_id": "",
"location": "",
"input": "",
"_links": {
"self": {
"href": ""
}
},
"application": "",
"node": {
"_links": {
"self": {
"href": ""
}
},
"name": "",
"uuid": ""
},
"command_id": "",
"state": "",
"message": "",
"index": "",
"timestamp": "",
"user": "",
"svm": {
"name": ""
},
"scope": ""
}
],
"_links": {
"next": {
"href": ""
},
"self": {
"href": ""
}
},
"num_records": ""
}

operation: Get Security Roles

Input parameters

Parameter	Description
Fields	Specify a comma-separated list of fields to return from NetApp ONTAP.
Limit	Specify the maximum count of records to fetch from NetApp ONTAP.
Return Records	Select whether to return the records or just the count of records. The default is true for GET calls. When set to false, only the number of records is sent by NetApp ONTAP.
Return Timeout	Specify, in seconds, the time to wait for the completion of execution. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
Sort Order	Select the sort order of results from the following options: Ascending Descending Default is Ascending.

Output

The output contains the following populated JSON schema:
{
"records": [
{
"owner": {
"_links": {
"self": {
"href": ""
}
},
"name": "",
"uuid": ""
},
"privileges": [
{
"access": "",
"_links": {
"self": {
"href": ""
}
},
"path": ""
}
],
"builtin": "",
"_links": {
"self": {
"href": ""
}
},
"name": "",
"scope": ""
}
],
"_links": {
"next": {
"href": ""
},
"self": {
"href": ""
}
},
"num_records": ""
}

operation: Update User Password

Input parameters

Parameter	Description
Name	Specify the user name of the account whose password you need to change in NetApp ONTAP.
Password	Specify the new password to update in NetApp ONTAP.
Owner Name	Specify the name of the SVM for an SVM-scoped user account in NetApp ONTAP.
Owner UUID	Specify the UUID of the SVM for an SVM-scoped user account in NetApp ONTAP.

Output

The output contains the following populated JSON schema:
{
"message": "",
"status": ""
}

Included playbooks

The Sample - NetApp ONTAP - 1.0.0 playbook collection comes bundled with the NetApp ONTAP connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the NetApp ONTAP connector.

• Get Security Accounts
• Get Security Audit Messages
• Get Security Roles
• Update User Password

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.