Cisco ASA
Use the Cisco Adaptive Security Appliance Software integration to manage interfaces, rules, and network objects.
Network Security · Cisco ASA
Details
| ID | Cisco ASA |
|---|---|
| Provider | Cisco Systems |
| Category | Network Security |
| From Version | 5.0.0 |
| Docker Image | demisto/python3:3.12.13.10116658 |
| Supported Modules | Agentix XSIAM EDR Cortex Cloud Cloud Runtime Security |
README
Use the Cisco Adaptive Security Appliance Software integration to manage interfaces, rules, and network objects.
This integration was integrated and tested with version 9.16(3)23 of Cisco ASA
Configure Cisco ASA in Cortex
| Parameter | Required |
|---|---|
| Server URL (e.g., https://192.168.0.1) | True |
| Credentials | True |
| Password | True |
| Use system proxy settings | False |
| Trust any certificate (not secure) | False |
| Is ASAv | False |
Commands
You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.
cisco-asa-list-network-object-group
Retrieve information about network object groups. Network object groups can contain multiple network objects as well as inline networks or hosts. Network object groups can include a mix of both IPv4 and IPv6 addresses/network.
Base Command
cisco-asa-list-network-object-group
Input
| Argument Name | Description | Required |
|---|---|---|
| object_id | The object ID of the network group to retrieve. This can’t be used with pagination arguments. | Optional |
| page | Page number of paginated results. Minimum of 1; default 1. | Optional |
| page_size | The number of items per page. Maximum of 100; default 50. | Optional |
| limit | The maximum number of records to retrieve. Maximum of 100; default 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.NetworkObjectGroup.object_id | String | The object ID of the network object group. |
| CiscoASA.NetworkObjectGroup.name | String | The name of the network object group. |
| CiscoASA.NetworkObjectGroup.description | String | The description of the network object group. |
| CiscoASA.NetworkObjectGroup.members.kind | String | The type of the network item. The viable types are IPv4Address, IPv4Network, IPv6Address, IPv6Network and objectRef#NetworkObj. |
| CiscoASA.NetworkObjectGroup.members.object_id | String | The object ID of the network object. |
| CiscoASA.NetworkObjectGroup.members.value | String | The value of IPv4Address, IPv4Network, IPv6Address or IPv6Network. |
Command example
!cisco-asa-list-network-object-group limit=1
Context Example
{
"CiscoASA": {
"NetworkObjectGroup": {
"description": "This is a test",
"members": [
{
"kind": "objectRef#NetworkObj",
"object_id": "Test_Lior"
},
{
"kind": "objectRef#NetworkObj",
"object_id": "Test_Lior1"
},
{
"kind": "objectRef#NetworkObj",
"object_id": "Test_Lior2"
}
],
"name": "TEST_GROUP1",
"object_id": "TEST_GROUP1"
}
}
}
Human Readable Output
Network Object Groups
Object Id Name Description Members TEST_GROUP1 TEST_GROUP1 This is a test {‘kind’: ‘objectRef#NetworkObj’, ‘object_id’: ‘Test_Lior’},
{‘kind’: ‘objectRef#NetworkObj’, ‘object_id’: ‘Test_Lior1’},
{‘kind’: ‘objectRef#NetworkObj’, ‘object_id’: ‘Test_Lior2’}
cisco-asa-list-local-user-group
Retrieve information about local user groups, which are collections of user accounts, either from the local database or imported from Active Directory, that manage access to network resources not defined globally.
Base Command
cisco-asa-list-local-user-group
Input
| Argument Name | Description | Required |
|---|---|---|
| object_id | The object ID of the local user group to retrieve. This can’t be used with pagination arguments. | Optional |
| page | Page number of paginated results. Minimum of 1; default 1. | Optional |
| page_size | The number of items per page. Maximum of 100; default 50. | Optional |
| limit | The maximum number of records to retrieve. Maximum of 100; default 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.LocalUserGroup.object_id | String | The object ID of the local user group. |
| CiscoASA.LocalUserGroup.name | String | The name of the local user group. |
| CiscoASA.LocalUserGroup.description | String | The description of the local user group. |
| CiscoASA.LocalUserGroup.members.kind | String | The type of the user. |
| CiscoASA.LocalUserGroup.members.object_id | String | The ID of the user. |
Command example
!cisco-asa-list-local-user-group limit=1
Context Example
{
"CiscoASA": {
"LocalUserGroup": {
"members": [
{
"kind": "objectRef#UserObj",
"object_id": "api"
},
{
"kind": "objectRef#UserObj",
"object_id": "restapi"
}
],
"name": "LIOR_GROUP",
"object_id": "LIOR_GROUP"
}
}
}
Human Readable Output
Local User Groups
Object Id Name Members LIOR_GROUP LIOR_GROUP {‘kind’: ‘objectRef#UserObj’, ‘object_id’: ‘api’},
{‘kind’: ‘objectRef#UserObj’, ‘object_id’: ‘restapi’}
cisco-asa-list-local-user
Retrieve information about individual local user accounts within a network system. These local users can be part of local user groups and groups imported from Active Directory.
Base Command
cisco-asa-list-local-user
Input
| Argument Name | Description | Required |
|---|---|---|
| object_id | The object ID of the local user to retrieve. This can’t be used with pagination arguments. | Optional |
| page | Page number of paginated results. Minimum of 1; default 1. | Optional |
| page_size | The number of items per page. Maximum of 100; default 50. | Optional |
| limit | The maximum number of records to retrieve. Maximum of 100; default 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.LocalUser.object_id | String | The object ID of the local user. |
| CiscoASA.LocalUser.name | String | The name of the local user. |
| CiscoASA.LocalUser.mschap_authenticated | Boolean | Whether Extensible Authentication Protocol-Microsoft Challenge Handshake Authentication Protocol is authenticated. |
| CiscoASA.LocalUser.privilege_level | Number | The user’s privilege level. |
| CiscoASA.LocalUser.asdm_cli_access_type | String | ASDM and CLI access type. Can be one of “Full”, “None”, “Cli”. |
Command example
!cisco-asa-list-local-user limit=1
Context Example
{
"CiscoASA": {
"LocalUser": {
"asdm_cli_access_type": "Full",
"mschap_authenticated": false,
"name": "admin",
"object_id": "admin",
"privilege_level": 15
}
}
}
Human Readable Output
Local Users
Object Id Name Privilege Level Asdm Cli Access Type admin admin 15 Full
cisco-asa-list-time-range
Retrieve information about time range objects. A time range object defines a specific time consisting of a start time, an end time, and optional recurring entries. You use these objects on ACL rules to provide time-based access to certain features or assets. For example, you could create an access rule that allows access to a particular server during working hours only.
Base Command
cisco-asa-list-time-range
Input
| Argument Name | Description | Required |
|---|---|---|
| object_id | The object ID of the time range to retrieve. This can’t be used with pagination arguments. | Optional |
| page | Page number of paginated results. Minimum of 1; default 1. | Optional |
| page_size | The number of items per page. Maximum of 100; default 50. | Optional |
| limit | The maximum number of records to retrieve. Maximum of 100; default 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.TimeRange.object_id | String | The object ID of the time range. |
| CiscoASA.TimeRange.name | String | The name of the time range. |
| CiscoASA.TimeRange.start | String | Time at which this time range starts. |
| CiscoASA.TimeRange.end | String | Time at which this time range ends. |
| CiscoASA.TimeRange.periodic.frequency | String | The days of the week at which this time range will run periodically. |
| CiscoASA.TimeRange.periodic.start_hour | Number | The hour at which this time range will start periodically. |
| CiscoASA.TimeRange.periodic.start_minute | Number | The minute at which this time range will start periodically. |
| CiscoASA.TimeRange.periodic.end_hour | Number | The hour at which this time range will end periodically. |
| CiscoASA.TimeRange.periodic.end_minute | Number | The minute at which this time range will end periodically. |
Command example
!cisco-asa-list-time-range page=1 page_size=1
Context Example
{
"CiscoASA": {
"TimeRange": {
"end": "03:47 May 14 2014",
"name": "trUserTest",
"object_id": "trUserTest",
"periodic": [
{
"end_hour": 23,
"end_minute": 59,
"frequency": "Wednesday to Thursday",
"start_hour": 4,
"start_minute": 3
}
],
"start": "now"
}
}
}
Human Readable Output
Time Ranges
Object Id Name Start End Periodic trUserTest trUserTest now 03:47 May 14 2014 {‘frequency’: ‘Wednesday to Thursday’, ‘start_hour’: 4, ‘start_minute’: 3, ‘end_hour’: 23, ‘end_minute’: 59}
cisco-asa-list-security-object-group
Retrieve information about security groups, which are collections of security groups or identifiers that manage access and permissions to network resources. These groups can be used in features like Cisco TrustSec and are often part of extended access control lists, enabling centralized and localized security policy management.
Base Command
cisco-asa-list-security-object-group
Input
| Argument Name | Description | Required |
|---|---|---|
| object_id | The object ID of the security object group to retrieve. This can’t be used with pagination arguments. | Optional |
| page | Page number of paginated results. Minimum of 1; default 1. | Optional |
| page_size | The number of items per page. Maximum of 100; default 50. | Optional |
| limit | The maximum number of records to retrieve. Maximum of 100; default 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.SecurityObjectGroup.object_id | String | The object ID of the security object group. |
| CiscoASA.SecurityObjectGroup.name | String | The name of the security object group. |
| CiscoASA.SecurityObjectGroup.description | String | The description of the security object group. |
| CiscoASA.SecurityObjectGroup.members.kind | String | The type of the security object group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. |
| CiscoASA.SecurityObjectGroup.members.value | String | The value of the SecurityName or SecurityTag. |
| CiscoASA.SecurityObjectGroup.members.object_id | String | The object ID of objectRef#SecurityObjGroup. |
Command example
!cisco-asa-list-security-object-group page=1 page_size=1
Context Example
{
"CiscoASA": {
"SecurityObjectGroup": {
"description": "test12",
"members": [
{
"kind": "SecurityName",
"value": "zeno1"
},
{
"kind": "SecurityTag",
"value": "71"
}
],
"name": "oneSecurityGroup",
"object_id": "oneSecurityGroup"
}
}
}
Human Readable Output
Security Object Groups
Object Id Name Description Members oneSecurityGroup oneSecurityGroup test12 {‘kind’: ‘SecurityName’, ‘value’: ‘zeno1’},
{‘kind’: ‘SecurityTag’, ‘value’: ‘71’}
cisco-asa-list-user-object
Retrieve information about user definitions within the system. This helps in managing and configuring user access and permissions in a network security context.
Base Command
cisco-asa-list-user-object
Input
| Argument Name | Description | Required |
|---|---|---|
| object_id | The object ID of the user object to retrieve. This can’t be used with pagination arguments. | Optional |
| page | Page number of paginated results. Minimum of 1; default 1. | Optional |
| page_size | The number of items per page. Maximum of 100; default 50. | Optional |
| limit | The maximum number of records to retrieve. Maximum of 100; default 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.UserObject.object_id | String | The object ID of the user object. |
| CiscoASA.UserObject.user_name | String | The user’s user name. |
| CiscoASA.UserObject.local_user_object_id | String | The object ID of the local user. |
| CiscoASA.UserObject.value | String | The value of the local user. |
Command example
!cisco-asa-list-user-object page=1 page_size=1
Context Example
{
"CiscoASA": {
"UserObject": {
"local_user_object_id": "api",
"object_id": "api",
"user_name": "api"
}
}
}
Human Readable Output
User Objects
Object Id User Name api api
cisco-asa-write-memory
Saves the running configuration to the default location for the startup configuration.
Base Command
cisco-asa-write-memory
Input
There are no input arguments for this command.
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.WriteMemory.response | String | Shows a successful ‘write memory’ command execution on a Cisco ASA device, building the configuration and generating a cryptochecksum for integrity. The process is completed with an “[OK]” message. |
Command example
#### Context Example
```json
{
"CiscoASA": {
"WriteMemory": {
"response": [
"Building configuration...\nCryptochecksum: fa399474 22b66df0 6e2a7619 b37adea3 \n\n20838 bytes copied in 0.50 secs\n[OK]\n"
]
}
}
}
Human Readable Output
Results
response Building configuration…
Cryptochecksum: fa399474 22b66df0 6e2a7619 b37adea3
20838 bytes copied in 0.50 secs
[OK]
cisco-asa-list-rules
Gets a list all rules for the supplied interface.
Base Command
cisco-asa-list-rules
Input
| Argument Name | Description | Required |
|---|---|---|
| interface_name | The name of the interface from which to get rules. | Optional |
| interface_type | The interface type. Possible values are: In, Out, Global. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.Rules.Source | String | The rule’s source. |
| CiscoASA.Rules.Dest | String | The rule’s destination. |
| CiscoASA.Rules.InterfaceType | String | The interface type. Can be “In”, “Out”, or “Global”. |
| CiscoASA.Rules.IsActive | Boolean | Whether the rule is active. |
| CiscoASA.Rules.Interface | String | The name of the interface. |
| CiscoASA.Rules.Position | Number | The position of the rule. |
| CiscoASA.Rules.ID | String | The rule ID. |
| CiscoASA.Rules.Remarks | Unknown | A list of all rule remarks. |
| CiscoASA.Rules.Permit | Boolean | Whether the rule permits traffic from source to destination. |
| CiscoASA.Rules.DestService | String | The destination service. |
| CiscoASA.Rules.SourceService | String | The source service. |
| CiscoASA.Rules.SourceKind | String | One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. |
| CiscoASA.Rules.DestKind | String | One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. |
| CiscoASA.Rules.SourceSecurity.kind | String | The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. |
| CiscoASA.Rules.SourceSecurity.value | String | The value of the SecurityName or SecurityTag. |
| CiscoASA.Rules.SourceSecurity.objectId | String | The object ID of objectRef#SecurityObjGroup. |
| CiscoASA.Rules.DestinationSecurity.kind | String | The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. |
| CiscoASA.Rules.DestinationSecurity.value | String | The value of the SecurityName or SecurityTag |
| CiscoASA.Rules.DestinationSecurity.objectId | String | The object ID of objectRef#SecurityObjGroup. |
| CiscoASA.Rules.User.kind | String | One of AnyUser, NoneUser, objectRef#LocalUserObjGroup, objectRef#UserGroupObj, objectRef#UserObj |
| CiscoASA.Rules.User.value | String | The user value. |
| CiscoASA.Rules.User.objectId | String | The object ID of the user. |
| CiscoASA.Rules.TimeRange.kind | String | The object reference type or the actual TimeRange value. |
| CiscoASA.Rules.TimeRange.value | String | The value of the time range. |
| CiscoASA.Rules.TimeRange.objectId | String | The object ID of the time range. |
Command example
!cisco-asa-list-rules interface_type=Global
Context Example
{
"CiscoASA": {
"Rules": [
{
"Dest": "TEST_GROUP2",
"DestKind": "objectRef#NetworkObjGroup",
"DestService": "ip",
"DestinationSecurity": {
"kind": "SecurityTag",
"value": "71"
},
"ID": "3583139358",
"Interface": null,
"InterfaceType": "Global",
"IsActive": true,
"Permit": false,
"Position": 1,
"Remarks": [],
"Source": "TEST_GROUP1",
"SourceKind": "objectRef#NetworkObjGroup",
"SourceSecurity": {
"kind": "objectRef#SecurityObjGroup",
"objectId": "oneSecurityGroup"
},
"SourceService": "ip",
"TimeRange": {
"kind": "objectRef#TimeRange",
"objectId": "trUserTest"
},
"User": {
"kind": "objectRef#UserObj",
"objectId": "api"
}
},
{
"Dest": "TEST_GROUP2",
"DestKind": "objectRef#NetworkObjGroup",
"DestService": "ip",
"ID": "3194110035",
"Interface": null,
"InterfaceType": "Global",
"IsActive": true,
"Permit": false,
"Position": 2,
"Remarks": [],
"Source": "TEST_GROUP1",
"SourceKind": "objectRef#NetworkObjGroup",
"SourceService": "ip",
"TimeRange": {
"kind": "objectRef#TimeRange",
"objectId": "trUserTest"
},
"User": {
"kind": "objectRef#UserObj",
"objectId": "api"
}
}
]
}
}
Human Readable Output
Rules
ID Source Dest Permit Interface InterfaceType IsActive Position SourceService DestService 3583139358 TEST_GROUP1 TEST_GROUP2 false Global true 1 ip ip 3194110035 TEST_GROUP1 TEST_GROUP2 false Global true 2 ip ip
cisco-asa-backup
Creates a backup of the current settings (i.e., the backup.cfg file).
Base Command
cisco-asa-backup
Input
| Argument Name | Description | Required |
|---|---|---|
| backup_name | The name of the backup. | Required |
| passphrase | The passphrase for the backup. | Optional |
Context Output
There is no context output for this command.
Command example
!cisco-asa-backup backup_name=Lior
Human Readable Output
Created backup successfully in:
Location: disk0:/Lior
Passphrase: None
cisco-asa-get-rule-by-id
Gets a specific rule by rule ID.
Base Command
cisco-asa-get-rule-by-id
Input
| Argument Name | Description | Required |
|---|---|---|
| rule_id | The rule ID. | Required |
| interface_name | The name of the interface. | Optional |
| interface_type | The interface type. Possible values are: In, Out, Global. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.Rules.Interface | String | The name of the interface. |
| CiscoASA.Rules.Source | String | The rule’s source. |
| CiscoASA.Rules.Dest | String | The rule’s destination. |
| CiscoASA.Rules.InterfaceType | String | The interface type. Can be “In”, “Out”, or “Global”. |
| CiscoASA.Rules.IsActive | Boolean | Whether the rule is active. |
| CiscoASA.Rules.Position | Number | The position of the rule. |
| CiscoASA.Rules.ID | String | The rule ID. |
| CiscoASA.Rules.Remarks | Unknown | A list of all rule remarks. |
| CiscoASA.Rules.Permit | Boolean | Whether the rule permits traffic from source to destination. |
| CiscoASA.Rules.DestService | String | The destination service. |
| CiscoASA.Rules.SourceService | String | The source service. |
| CiscoASA.Rules.SourceKind | String | One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. |
| CiscoASA.Rules.DestKind | String | One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. |
| CiscoASA.Rules.SourceSecurity.kind | String | The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. |
| CiscoASA.Rules.SourceSecurity.value | String | The value of the SecurityName or SecurityTag. |
| CiscoASA.Rules.SourceSecurity.objectId | String | The object ID of objectRef#SecurityObjGroup. |
| CiscoASA.Rules.DestinationSecurity.kind | String | The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. |
| CiscoASA.Rules.DestinationSecurity.value | String | The value of the SecurityName or SecurityTag |
| CiscoASA.Rules.DestinationSecurity.objectId | String | The object ID of objectRef#SecurityObjGroup. |
| CiscoASA.Rules.User.kind | String | One of AnyUser, NoneUser, objectRef#LocalUserObjGroup, objectRef#UserGroupObj, objectRef#UserObj |
| CiscoASA.Rules.User.value | String | The user value. |
| CiscoASA.Rules.User.objectId | String | The object ID of the user. |
| CiscoASA.Rules.TimeRange.kind | String | The object reference type or the actual TimeRange value. |
| CiscoASA.Rules.TimeRange.value | String | The value of the time range. |
| CiscoASA.Rules.TimeRange.objectId | String | The object ID of the time range. |
Command example
!cisco-asa-get-rule-by-id interface_type=Global rule_id=3371063501
Context Example
{
"CiscoASA": {
"Rules": {
"Dest": "5.5.5.5",
"DestKind": "IPv4Address",
"DestService": "tcp/citrix-ica",
"DestinationSecurity": {
"kind": "SecurityTag",
"value": "1"
},
"ID": "3371063501",
"Interface": "",
"InterfaceType": "Global",
"IsActive": true,
"Permit": false,
"Position": 30,
"Remarks": [],
"Source": "0.0.0.0/24",
"SourceKind": "IPv4Network",
"SourceSecurity": {
"kind": "SecurityTag",
"value": "2"
},
"SourceService": "tcp/cifs",
"User": {
"kind": "objectRef#UserObj",
"objectId": "api"
}
}
}
}
Human Readable Output
Rule 3371063501
ID Source Dest Permit Interface InterfaceType IsActive Position SourceService DestService 3371063501 0.0.0.0/24 5.5.5.5 false Global true 30 tcp/cifs tcp/citrix-ica
cisco-asa-create-rule
Creates a rule.
Base Command
cisco-asa-create-rule
Input
| Argument Name | Description | Required |
|---|---|---|
| source | The source. Can be the value of an IPv4, an address block, or the name of a network object. | Required |
| destination | The destination. Can be the value of an IPv4, an address block, or the name of a network object. | Required |
| permit | Whether the rule is a permit. If True, the rule is a permit. Possible values are: True, False. | Required |
| remarks | A list of remarks for the rule. | Optional |
| position | The position in which to create the rule. | Optional |
| log_level | The log level of the rule. Possible values are: Default, Emergencies, Alerts, Critical, Errors, Warnings, Notifications, Informational, Debugging. | Optional |
| active | Whether the rule will be active. If True, the rule will be active. Possible values are: True, False. | Optional |
| interface_type | The interface type. Possible values are: In, Out, Global. | Required |
| interface_name | The interface name. | Optional |
| service | The service of the rule. | Optional |
| destination_kind | The destination address kind in the ace. Possible values are: AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, NetworkObj, NetworkObjGroup. | Optional |
| source_kind | The source address kind in the ace. Possible values are: AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, NetworkObj, NetworkObjGroup. | Optional |
| service_kind | The source service kind. Possible values are: AnyService, ICMP6Service, ICMPService, NetworkProtocol, NetworkServiceGroups, NetworkServiceObjects, TcpUdpService. | Optional |
| destination_service | The destination service value. | Optional |
| destination_service_kind | The destination service kind. Possible values are: AnyService, ICMP6Service, ICMPService, NetworkProtocol, NetworkServiceGroups, NetworkServiceObjects, TcpUdpService. | Optional |
| time_range | Object ID of for the time range object. Can be received with the command cisco-asa-list-time-range. | Optional |
| user | The object ID to the user. Can be one of LocalUserObjGroup, UserGroupObj, UserObj. Can be received with existing commands; cisco-asa-list-local-user-group, cisco-asa-list-local-user, cisco-asa-list-user-object. | Optional |
| user_kind | The type of the user. Possible values are: LocalUserObjGroup, UserGroupObj, UserObj. | Optional |
| source_security | Source security group in the ace. Possible values are SecurityName, SecurityTag and SecurityObjGroup. Can be received with the existing command cisco-asa-list-security-object-group. | Optional |
| source_security_kind | The source security type. Possible values are: SecurityName, SecurityTag, SecurityObjGroup. | Optional |
| destination_security | Destination security group in the ace. Possible values are SecurityName, SecurityTag and SecurityObjGroup. Can be received with the existing command cisco-asa-list-security-object-group. | Optional |
| destination_security_kind | The destination security type. Possible values are: SecurityName, SecurityTag, SecurityObjGroup. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.Rules.Source | String | The rule’s source. |
| CiscoASA.Rules.Dest | String | The rule’s destination. |
| CiscoASA.Rules.InterfaceType | String | The interface type. Can be “In”, “Out”, or “Global”. |
| CiscoASA.Rules.IsActive | Boolean | Whether the rule is active. |
| CiscoASA.Rules.Interface | String | The name of the interface. |
| CiscoASA.Rules.Position | Number | The position of the rule. |
| CiscoASA.Rules.ID | String | The rule ID. |
| CiscoASA.Rules.Remarks | Unknown | A list of all rule remarks. |
| CiscoASA.Rules.Permit | Boolean | Whether the rule permits traffic from source to destination. |
| CiscoASA.Rules.DestService | String | The destination service. |
| CiscoASA.Rules.SourceService | String | The source service. |
| CiscoASA.Rules.SourceKind | String | One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. |
| CiscoASA.Rules.DestKind | String | One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. |
| CiscoASA.Rules.SourceSecurity.kind | String | The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. |
| CiscoASA.Rules.SourceSecurity.value | String | The value of the SecurityName or SecurityTag |
| CiscoASA.Rules.SourceSecurity.objectId | String | The object ID of objectRef#SecurityObjGroup. |
| CiscoASA.Rules.DestinationSecurity.kind | String | The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. |
| CiscoASA.Rules.DestinationSecurity.value | String | The value of the SecurityName or SecurityTag |
| CiscoASA.Rules.DestinationSecurity.objectId | String | The object ID of objectRef#SecurityObjGroup. |
| CiscoASA.Rules.User.kind | String | One of AnyUser, NoneUser, objectRef#LocalUserObjGroup, objectRef#UserGroupObj, objectRef#UserObj |
| CiscoASA.Rules.User.value | String | The user value. |
| CiscoASA.Rules.User.objectId | String | The object ID of the user. |
| CiscoASA.Rules.TimeRange.kind | String | The object reference type or the actual TimeRange value. |
| CiscoASA.Rules.TimeRange.value | String | The value of the time range. |
| CiscoASA.Rules.TimeRange.objectId | String | The object ID of the time range. |
Command example
!cisco-asa-create-rule destination=1.1.1.1 source=0.0.0.0/24 interface_type=Global permit=False destination_kind=IPv4Address source_kind=IPv4Network active=False service_kind=TcpUdpService service=tcp/cifs destination_service=tcp/citrix-ica destination_service_kind=TcpUdpService destination_security_kind=SecurityTag destination_security=1 source_security_kind=SecurityTag source_security=2 timerange=trUserTest user_kind=UserObj user=api
Context Example
{
"CiscoASA": {
"Rules": {
"Dest": "1.1.1.1",
"DestKind": "IPv4Address",
"DestService": "tcp/citrix-ica",
"DestinationSecurity": {
"kind": "SecurityTag",
"value": "1"
},
"ID": "3152305802",
"Interface": "",
"InterfaceType": "Global",
"IsActive": false,
"Permit": false,
"Position": 37,
"Remarks": [],
"Source": "0.0.0.0/24",
"SourceKind": "IPv4Network",
"SourceSecurity": {
"kind": "SecurityTag",
"value": "2"
},
"SourceService": "tcp/cifs",
"User": {
"kind": "objectRef#UserObj",
"objectId": "api"
}
}
}
}
Human Readable Output
Created new rule. ID: 3152305802
ID Source Dest Permit Interface InterfaceType IsActive Position SourceService DestService 3152305802 0.0.0.0/24 1.1.1.1 false Global false 37 tcp/cifs tcp/citrix-ica
cisco-asa-delete-rule
Deletes a rule.
Base Command
cisco-asa-delete-rule
Input
| Argument Name | Description | Required |
|---|---|---|
| rule_id | The rule ID. | Required |
| interface_name | The name of the interface. | Optional |
| interface_type | The interface type. Possible values are: In, Out, Global. | Required |
Context Output
There is no context output for this command.
Command example
!cisco-asa-delete-rule rule_id=2152246838 interface_type=Global
Human Readable Output
Rule 2152246838 deleted successfully.
cisco-asa-edit-rule
Updates an existing rule.
Base Command
cisco-asa-edit-rule
Input
| Argument Name | Description | Required |
|---|---|---|
| interface_type | The interface type. Possible values are: In, Out, Global. | Required |
| interface_name | The interface name. | Optional |
| rule_id | The rule ID. | Required |
| active | Whether the rule will be active. If True, will be active. Possible values are: True, False. | Optional |
| log_level | The log level of the rule. | Optional |
| position | The position the rule will be in. . | Optional |
| remarks | A list of remarks for the rule. | Optional |
| permit | True if the rule is a permit. Possible values are: True, False. | Optional |
| destination | The destination. Can be the value of an IPv4, an address block, or the name of a network object. | Optional |
| source | The source. Can be the value of an IPv4, an address block, or the name of a network object. | Optional |
| service | The service of the rule. | Optional |
| destination_kind | The destination address kind in the ace. Possible values are: AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, NetworkObj, NetworkObjGroup. | Optional |
| source_kind | The source address kind in the ace. Possible values are: AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, NetworkObj, NetworkObjGroup. | Optional |
| service_kind | The source service kind. Possible values are: AnyService, ICMP6Service, ICMPService, NetworkProtocol, NetworkServiceGroups, NetworkServiceObjects, TcpUdpService. | Optional |
| destination_service | The destination service value. | Optional |
| destination_service_kind | The destination service kind. Possible values are: AnyService, ICMP6Service, ICMPService, NetworkProtocol, NetworkServiceGroups, NetworkServiceObjects, TcpUdpService. | Optional |
| time_range | Object ID of for the time range object. Can be received with the command cisco-asa-list-time-range. | Optional |
| user | The object ID to the user. Can be one of LocalUserObjGroup, UserGroupObj, UserObj. Can be received with existing commands; cisco-asa-list-local-user-group, cisco-asa-list-local-user, cisco-asa-list-user-object. | Optional |
| user_kind | The type of the user. Possible values are: LocalUserObjGroup, UserGroupObj, UserObj. | Optional |
| source_security | Source security group in the ace. Possible values are SecurityName, SecurityTag and SecurityObjGroup. Can be received with the existing command cisco-asa-list-security-object-group. | Optional |
| source_security_kind | The source security type. Possible values are: SecurityName, SecurityTag, SecurityObjGroup. | Optional |
| destination_security | Destination security group in the ace. Possible values are SecurityName, SecurityTag and SecurityObjGroup. Can be received with the existing command cisco-asa-list-security-object-group. | Optional |
| destination_security_kind | The destination security type. Possible values are: SecurityName, SecurityTag, SecurityObjGroup. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.Rules.Source | String | The rule’s source. |
| CiscoASA.Rules.Dest | String | The rule’s destination. |
| CiscoASA.Rules.InterfaceType | String | The interface type. Can be “In”, “Out”, or “Global”. |
| CiscoASA.Rules.IsActive | Boolean | Whether the rule is active. |
| CiscoASA.Rules.Interface | String | The name of the interface. |
| CiscoASA.Rules.Position | Number | The position of the rule. |
| CiscoASA.Rules.ID | String | The rule ID. |
| CiscoASA.Rules.Remarks | Unknown | A list of all rule remarks. |
| CiscoASA.Rules.Permit | Boolean | Whether the rule permits traffic from source to destination. |
| CiscoASA.Rules.DestService | String | The destination service. |
| CiscoASA.Rules.SourceService | String | The source service. |
| CiscoASA.Rules.SourceKind | String | One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. |
| CiscoASA.Rules.DestKind | String | One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. |
| CiscoASA.Rules.SourceSecurity.kind | String | The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. |
| CiscoASA.Rules.SourceSecurity.value | String | The value of the SecurityName or SecurityTag |
| CiscoASA.Rules.SourceSecurity.objectId | String | The object ID of objectRef#SecurityObjGroup. |
| CiscoASA.Rules.DestinationSecurity.kind | String | The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. |
| CiscoASA.Rules.DestinationSecurity.value | String | The value of the SecurityName or SecurityTag |
| CiscoASA.Rules.DestinationSecurity.objectId | String | The object ID of objectRef#SecurityObjGroup. |
| CiscoASA.Rules.User.kind | String | One of AnyUser, NoneUser, objectRef#LocalUserObjGroup, objectRef#UserGroupObj, objectRef#UserObj |
| CiscoASA.Rules.User.value | String | The user value. |
| CiscoASA.Rules.User.objectId | String | The object ID of the user. |
| CiscoASA.Rules.TimeRange.kind | String | The object reference type or the actual TimeRange value. |
| CiscoASA.Rules.TimeRange.value | String | The value of the time range. |
| CiscoASA.Rules.TimeRange.objectId | String | The object ID of the time range. |
Command example
!cisco-asa-edit-rule rule_id=3371063501 interface_type=Global active=True
Context Example
{
"CiscoASA": {
"Rules": {
"Dest": "5.5.5.5",
"DestKind": "IPv4Address",
"DestService": "tcp/citrix-ica",
"DestinationSecurity": {
"kind": "SecurityTag",
"value": "1"
},
"ID": "3371063501",
"Interface": "",
"InterfaceType": "Global",
"IsActive": true,
"Permit": false,
"Position": 30,
"Remarks": [],
"Source": "0.0.0.0/24",
"SourceKind": "IPv4Network",
"SourceSecurity": {
"kind": "SecurityTag",
"value": "2"
},
"SourceService": "tcp/cifs",
"User": {
"kind": "objectRef#UserObj",
"objectId": "api"
}
}
}
}
Human Readable Output
Edited rule 3371063501
ID Source Dest Permit Interface InterfaceType IsActive Position SourceService DestService 3371063501 0.0.0.0/24 5.5.5.5 false Global true 30 tcp/cifs tcp/citrix-ica
cisco-asa-list-network-objects
Gets a list all configured network objects.
Base Command
cisco-asa-list-network-objects
Input
| Argument Name | Description | Required |
|---|---|---|
| object_name | A comma-separated list of network object names for which to get the network. | Optional |
| object_id | A comma-separated list of object IDs for which to get the network object. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.NetworkObject.ID | String | The ID of the network object. |
| CiscoASA.NetworkObject.Host | String | The host information of the network object. |
| CiscoASA.NetworkObject.Description | String | A description of the network object. |
| CiscoASA.NetworkObject.Name | String | The name of the network object. |
Command example
!cisco-asa-list-network-objects object_name=Test_Lior
Context Example
{
"CiscoASA": {
"NetworkObject": {
"Host": {
"kind": "IPv4Address",
"value": "0.0.0.0"
},
"ID": "Test_Lior",
"Name": "Test_Lior"
}
}
}
Human Readable Output
Network Objects
ID Name Host Description Test_Lior Test_Lior kind: IPv4Address
value: 0.0.0.0
cisco-asa-create-network-object
Creates a network object.
Base Command
cisco-asa-create-network-object
Input
| Argument Name | Description | Required |
|---|---|---|
| object_type | The type of network object to create. Possible values are: IPv4, IP-Network. | Required |
| object_name | The name of the object to create. | Required |
| object_value | The value of the network object to create. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.NetworkObject.ID | String | The ID of the network object. |
| CiscoASA.NetworkObject.Host | String | The host information of the network object. |
| CiscoASA.NetworkObject.Description | String | A description of the network object, if exists. |
| CiscoASA.NetworkObject.Name | String | The name of the network object. |
Command example
!cisco-asa-create-network-object object_name=HelloThereLiorSB object_type=IPv4 object_value=1.1.1.1
Context Example
{
"CiscoASA": {
"NetworkObject": {
"Host": {
"kind": "IPv4Address",
"value": "1.1.1.1"
},
"ID": "HelloThereLiorSB",
"Name": "HelloThereLiorSB"
}
}
}
Human Readable Output
Network Objects
ID Name Host Description HelloThereLiorSB HelloThereLiorSB kind: IPv4Address
value: 1.1.1.1
cisco-asa-list-interfaces
Gets a list of all interfaces.
Base Command
cisco-asa-list-interfaces
Input
There are no input arguments for this command.
Context Output
| Path | Type | Description |
|---|---|---|
| CiscoASA.Interface.ID | String | The interface ID. |
| CiscoASA.Interface.Name | String | The interface name. |
| CiscoASA.Interface.Type | String | The type of interface. |
Command example
#### Context Example
```json
{
"CiscoASA": {
"Interface": [
{
"ID": "-1",
"Name": null,
"Type": "Global"
},
{
"ID": "GigabitEthernet0_API_SLASH_0",
"Name": "outside",
"Type": "In"
},
{
"ID": "Management0_API_SLASH_0",
"Name": "inside",
"Type": "Out"
}
]
}
}
Human Readable Output
Interfaces
Type ID Name Global -1 In GigabitEthernet0_API_SLASH_0 outside Out Management0_API_SLASH_0 inside
Configuration parameters
server— Server URL (e.g. https://192.168.0.1) (required)credentials— Credentials (required)proxy— Use system proxy settingsinsecure— Trust any certificate (not secure)isASAv— Is ASAv
Commands (16)
-
cisco-asa-backupCreates a backup of the current settings (i.e., the backup.cfg file).
-
cisco-asa-create-network-objectCreates a network object.
-
cisco-asa-create-ruleCreates a rule.
-
cisco-asa-delete-ruleDeletes a rule.
-
cisco-asa-edit-ruleUpdates an existing rule.
-
cisco-asa-get-rule-by-idGets a specific rule by rule ID.
-
cisco-asa-list-interfacesGets a list of all interfaces.
-
cisco-asa-list-local-userRetrieve information about individual local user accounts within a network system. These local users can be part of local user groups and groups imported from Active Directory.
-
cisco-asa-list-local-user-groupRetrieve information about local user groups, which are collections of user accounts, either from the local database or imported from Active Directory, that manage access to network resources not defined globally.
-
cisco-asa-list-network-object-groupRetrieve information about network object groups. Network object groups can contain multiple network objects as well as inline networks or hosts. Network object groups can include a mix of both IPv4 and IPv6 addresses/network.
-
cisco-asa-list-network-objectsGets a list all configured network objects.
-
cisco-asa-list-rulesGets a list all rules for the supplied interface.
-
cisco-asa-list-security-object-groupRetrieve information about security groups, which are collections of security groups or identifiers that manage access and permissions to network resources. These groups can be used in features like Cisco TrustSec and are often part of extended access control lists, enabling centralized and localized security policy management.
-
cisco-asa-list-time-rangeRetrieve information about time range objects. A time range object defines a specific time consisting of a start time, an end time, and optional recurring entries. You use these objects on ACL rules to provide time-based access to certain features or assets. For example, you could create an access rule that allows access to a particular server during working hours only.
-
cisco-asa-list-user-objectRetrieve information about user definitions within the system. This helps in managing and configuring user access and permissions in a network security context.
-
cisco-asa-write-memorySaves the running configuration to the default location for the startup configuration.
category: Network Security provider: Cisco Systems commonfields: id: Cisco ASA version: -1 configuration: - display: Server URL (e.g. https://192.168.0.1) name: server required: true type: 0 - display: Credentials name: credentials required: true type: 9 - defaultvalue: 'false' display: Use system proxy settings name: proxy type: 8 required: false - defaultvalue: 'false' display: Trust any certificate (not secure) name: insecure type: 8 required: false - display: Is ASAv name: isASAv type: 8 required: false description: Use the Cisco Adaptive Security Appliance Software integration to manage interfaces, rules, and network objects. display: Cisco ASA name: Cisco ASA script: commands: - arguments: - description: The object ID of the network group to retrieve. This can't be used with pagination arguments. name: object_id - description: 'Page number of paginated results. Minimum of 1; default 1.' name: page - name: page_size description: The number of items per page. Maximum of 100; default 50. - name: limit description: The maximum number of records to retrieve. Maximum of 100; default 50. defaultValue: '50' description: Retrieve information about network object groups. Network object groups can contain multiple network objects as well as inline networks or hosts. Network object groups can include a mix of both IPv4 and IPv6 addresses/network. name: cisco-asa-list-network-object-group outputs: - contextPath: CiscoASA.NetworkObjectGroup.object_id description: The object ID of the network object group. type: String - contextPath: CiscoASA.NetworkObjectGroup.name description: The name of the network object group. type: String - contextPath: CiscoASA.NetworkObjectGroup.description description: The description of the network object group. type: String - contextPath: CiscoASA.NetworkObjectGroup.members.kind description: The type of the network item. The viable types are IPv4Address, IPv4Network, IPv6Address, IPv6Network and objectRef#NetworkObj. type: String - contextPath: CiscoASA.NetworkObjectGroup.members.object_id description: The object ID of the network object. type: String - contextPath: CiscoASA.NetworkObjectGroup.members.value description: The value of IPv4Address, IPv4Network, IPv6Address or IPv6Network. type: String - arguments: - description: The object ID of the local user group to retrieve. This can't be used with pagination arguments. name: object_id - description: Page number of paginated results. Minimum of 1; default 1. name: page - name: page_size description: The number of items per page. Maximum of 100; default 50. - name: limit description: The maximum number of records to retrieve. Maximum of 100; default 50. defaultValue: '50' description: Retrieve information about local user groups, which are collections of user accounts, either from the local database or imported from Active Directory, that manage access to network resources not defined globally. name: cisco-asa-list-local-user-group outputs: - type: String contextPath: CiscoASA.LocalUserGroup.object_id description: The object ID of the local user group. - type: String contextPath: CiscoASA.LocalUserGroup.name description: The name of the local user group. - type: String contextPath: CiscoASA.LocalUserGroup.description description: The description of the local user group. - type: String contextPath: CiscoASA.LocalUserGroup.members.kind description: The type of the user. - type: String contextPath: CiscoASA.LocalUserGroup.members.object_id description: The ID of the user. - arguments: - description: The object ID of the local user to retrieve. This can't be used with pagination arguments. name: object_id - description: Page number of paginated results. Minimum of 1; default 1. name: page - description: The number of items per page. Maximum of 100; default 50. name: page_size - name: limit description: The maximum number of records to retrieve. Maximum of 100; default 50. defaultValue: '50' description: Retrieve information about individual local user accounts within a network system. These local users can be part of local user groups and groups imported from Active Directory. name: cisco-asa-list-local-user outputs: - contextPath: CiscoASA.LocalUser.object_id description: The object ID of the local user. type: String - contextPath: CiscoASA.LocalUser.name description: The name of the local user. type: String - contextPath: CiscoASA.LocalUser.mschap_authenticated description: Whether Extensible Authentication Protocol-Microsoft Challenge Handshake Authentication Protocol is authenticated. type: Boolean - contextPath: CiscoASA.LocalUser.privilege_level description: The user's privilege level. type: Number - contextPath: CiscoASA.LocalUser.asdm_cli_access_type description: ASDM and CLI access type. Can be one of "Full", "None", "Cli". type: String - arguments: - description: The object ID of the time range to retrieve. This can't be used with pagination arguments. name: object_id - description: Page number of paginated results. Minimum of 1; default 1. name: page - description: The number of items per page. Maximum of 100; default 50. name: page_size - description: The maximum number of records to retrieve. Maximum of 100; default 50. name: limit defaultValue: '50' description: Retrieve information about time range objects. A time range object defines a specific time consisting of a start time, an end time, and optional recurring entries. You use these objects on ACL rules to provide time-based access to certain features or assets. For example, you could create an access rule that allows access to a particular server during working hours only. name: cisco-asa-list-time-range outputs: - contextPath: CiscoASA.TimeRange.object_id description: The object ID of the time range. type: String - contextPath: CiscoASA.TimeRange.name description: The name of the time range. type: String - contextPath: CiscoASA.TimeRange.start description: Time at which this time range starts. type: String - contextPath: CiscoASA.TimeRange.end description: Time at which this time range ends. type: String - contextPath: CiscoASA.TimeRange.periodic.frequency description: The days of the week at which this time range will run periodically. type: String - contextPath: CiscoASA.TimeRange.periodic.start_hour description: The hour at which this time range will start periodically. type: Number - contextPath: CiscoASA.TimeRange.periodic.start_minute description: The minute at which this time range will start periodically. type: Number - contextPath: CiscoASA.TimeRange.periodic.end_hour description: The hour at which this time range will end periodically. type: Number - contextPath: CiscoASA.TimeRange.periodic.end_minute description: The minute at which this time range will end periodically. type: Number - arguments: - description: The object ID of the security object group to retrieve. This can't be used with pagination arguments. name: object_id - description: Page number of paginated results. Minimum of 1; default 1. name: page - description: The number of items per page. Maximum of 100; default 50. name: page_size - name: limit description: The maximum number of records to retrieve. Maximum of 100; default 50. defaultValue: '50' description: Retrieve information about security groups, which are collections of security groups or identifiers that manage access and permissions to network resources. These groups can be used in features like Cisco TrustSec and are often part of extended access control lists, enabling centralized and localized security policy management. name: cisco-asa-list-security-object-group outputs: - type: String contextPath: CiscoASA.SecurityObjectGroup.object_id description: The object ID of the security object group. - type: String contextPath: CiscoASA.SecurityObjectGroup.name description: The name of the security object group. - type: String contextPath: CiscoASA.SecurityObjectGroup.description description: The description of the security object group. - type: String contextPath: CiscoASA.SecurityObjectGroup.members.kind description: The type of the security object group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. - type: String contextPath: CiscoASA.SecurityObjectGroup.members.value description: The value of the SecurityName or SecurityTag. - type: String contextPath: CiscoASA.SecurityObjectGroup.members.object_id description: The object ID of objectRef#SecurityObjGroup. - arguments: - description: The object ID of the user object to retrieve. This can't be used with pagination arguments. name: object_id - description: Page number of paginated results. Minimum of 1; default 1. name: page - description: The number of items per page. Maximum of 100; default 50. name: page_size - description: The maximum number of records to retrieve. Maximum of 100; default 50. name: limit defaultValue: '50' description: Retrieve information about user definitions within the system. This helps in managing and configuring user access and permissions in a network security context. name: cisco-asa-list-user-object outputs: - contextPath: CiscoASA.UserObject.object_id description: The object ID of the user object. type: String - contextPath: CiscoASA.UserObject.user_name description: The user's user name. type: String - contextPath: CiscoASA.UserObject.local_user_object_id description: The object ID of the local user. type: String - contextPath: CiscoASA.UserObject.value description: The value of the local user. type: String - description: Saves the running configuration to the default location for the startup configuration. name: cisco-asa-write-memory outputs: - contextPath: CiscoASA.WriteMemory.response description: Shows a successful 'write memory' command execution on a Cisco ASA device, building the configuration and generating a cryptochecksum for integrity. The process is completed with an "[OK]" message. type: String - arguments: - description: The name of the interface from which to get rules. name: interface_name - description: 'The interface type. Can be "In", "Out", or "Global". ' name: interface_type auto: PREDEFINED predefined: - In - Out - Global description: Gets a list all rules for the supplied interface. name: cisco-asa-list-rules outputs: - contextPath: CiscoASA.Rules.Source description: The rule's source. type: String - contextPath: CiscoASA.Rules.Dest description: The rule's destination. type: String - contextPath: CiscoASA.Rules.InterfaceType description: The interface type. Can be "In", "Out", or "Global". type: String - contextPath: CiscoASA.Rules.IsActive description: Whether the rule is active. type: Boolean - contextPath: CiscoASA.Rules.Interface description: The name of the interface. type: String - contextPath: CiscoASA.Rules.Position description: The position of the rule. type: Number - contextPath: CiscoASA.Rules.ID description: The rule ID. type: String - contextPath: CiscoASA.Rules.Remarks description: A list of all rule remarks. type: Unknown - contextPath: CiscoASA.Rules.Permit description: Whether the rule permits traffic from source to destination. type: Boolean - contextPath: CiscoASA.Rules.DestService description: The destination service. type: String - contextPath: CiscoASA.Rules.SourceService description: The source service. type: String - contextPath: CiscoASA.Rules.SourceKind description: One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. type: String - contextPath: CiscoASA.Rules.DestKind description: One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. type: String - contextPath: CiscoASA.Rules.SourceSecurity.kind description: The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.SourceSecurity.value description: The value of the SecurityName or SecurityTag. type: String - contextPath: CiscoASA.Rules.SourceSecurity.objectId description: The object ID of objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.kind description: The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.value description: The value of the SecurityName or SecurityTag. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.objectId description: The object ID of objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.User.kind description: One of AnyUser, NoneUser, objectRef#LocalUserObjGroup, objectRef#UserGroupObj, objectRef#UserObj. type: String - contextPath: CiscoASA.Rules.User.value description: The user value. type: String - contextPath: CiscoASA.Rules.User.objectId description: The object ID of the user. type: String - contextPath: CiscoASA.Rules.TimeRange.kind description: The object reference type or the actual TimeRange value. type: String - contextPath: CiscoASA.Rules.TimeRange.value description: The value of the time range. type: String - contextPath: CiscoASA.Rules.TimeRange.objectId description: The object ID of the time range. type: String - description: Creates a backup of the current settings (i.e., the backup.cfg file). name: cisco-asa-backup arguments: - description: The name of the backup. name: backup_name required: true - description: The passphrase for the backup. name: passphrase - arguments: - description: The rule ID. name: rule_id required: true - description: The name of the interface. name: interface_name - auto: PREDEFINED description: The interface type. Can be "In", "Out", or "Global". name: interface_type predefined: - In - Out - Global required: true description: Gets a specific rule by rule ID. name: cisco-asa-get-rule-by-id outputs: - contextPath: CiscoASA.Rules.Interface description: The name of the interface. type: String - contextPath: CiscoASA.Rules.Source description: The rule's source. type: String - contextPath: CiscoASA.Rules.Dest description: The rule's destination. type: String - contextPath: CiscoASA.Rules.InterfaceType description: The interface type. Can be "In", "Out", or "Global". type: String - contextPath: CiscoASA.Rules.IsActive description: Whether the rule is active. type: Boolean - contextPath: CiscoASA.Rules.Position description: The position of the rule. type: Number - contextPath: CiscoASA.Rules.ID description: "The rule ID." type: String - contextPath: CiscoASA.Rules.Remarks description: A list of all rule remarks. type: Unknown - contextPath: CiscoASA.Rules.Permit description: Whether the rule permits traffic from source to destination. type: Boolean - contextPath: CiscoASA.Rules.DestService description: The destination service. type: String - contextPath: CiscoASA.Rules.SourceService description: The source service. type: String - contextPath: CiscoASA.Rules.SourceKind description: One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. type: String - contextPath: CiscoASA.Rules.DestKind description: One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. type: String - contextPath: CiscoASA.Rules.SourceSecurity.kind description: The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.SourceSecurity.value description: The value of the SecurityName or SecurityTag. type: String - contextPath: CiscoASA.Rules.SourceSecurity.objectId description: The object ID of objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.kind description: The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.value description: The value of the SecurityName or SecurityTag. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.objectId description: The object ID of objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.User.kind description: One of AnyUser, NoneUser, objectRef#LocalUserObjGroup, objectRef#UserGroupObj, objectRef#UserObj. type: String - contextPath: CiscoASA.Rules.User.value description: The user value. type: String - contextPath: CiscoASA.Rules.User.objectId description: The object ID of the user. type: String - contextPath: CiscoASA.Rules.TimeRange.kind description: The object reference type or the actual TimeRange value. type: String - contextPath: CiscoASA.Rules.TimeRange.value description: The value of the time range. type: String - contextPath: CiscoASA.Rules.TimeRange.objectId description: The object ID of the time range. type: String - arguments: - description: The source. Can be the value of an IPv4, an address block, or the name of a network object. name: source required: true - description: The destination. Can be the value of an IPv4, an address block, or the name of a network object. name: destination required: true - auto: PREDEFINED description: Whether the rule is a permit. If True, the rule is a permit. name: permit predefined: - 'True' - 'False' required: true - description: A list of remarks for the rule. isArray: true name: remarks - description: 'The position in which to create the rule.' name: position - auto: PREDEFINED description: The log level of the rule. Can be "Default", "Emergencies", "Alerts", "Critical", "Errors", "Warnings", "Notifications", "Informational", or "Debugging". name: log_level predefined: - Default - Emergencies - Alerts - Critical - Errors - Warnings - Notifications - Informational - Debugging - auto: PREDEFINED description: Whether the rule will be active. If True, the rule will be active. name: active predefined: - 'True' - 'False' defaultValue: 'True' - auto: PREDEFINED description: The interface type. Can be "In", "Out", or "Global". name: interface_type predefined: - In - Out - Global required: true - description: The interface name. name: interface_name - description: The service of the rule. name: service - auto: PREDEFINED description: The destination address type in the ace. name: destination_kind predefined: - AnyIPAddress - IPv4Address - IPv4FQDN - IPv4Network - IPv4Range - IPv6Address - IPv6FQDN - IPv6Network - IPv6Range - SecurityName - SecurityTag - interfaceIP - NetworkObj - NetworkObjGroup - auto: PREDEFINED description: The source address type in the ace. name: source_kind predefined: - AnyIPAddress - IPv4Address - IPv4FQDN - IPv4Network - IPv4Range - IPv6Address - IPv6FQDN - IPv6Network - IPv6Range - SecurityName - SecurityTag - interfaceIP - NetworkObj - NetworkObjGroup - auto: PREDEFINED description: The source service type. name: service_kind predefined: - AnyService - ICMP6Service - ICMPService - NetworkProtocol - NetworkServiceGroups - NetworkServiceObjects - TcpUdpService - description: The destination service value. name: destination_service - auto: PREDEFINED description: The destination service type. name: destination_service_kind predefined: - AnyService - ICMP6Service - ICMPService - NetworkProtocol - NetworkServiceGroups - NetworkServiceObjects - TcpUdpService - auto: PREDEFINED description: Object ID of for the time range object. Can be received with the command cisco-asa-list-time-range. name: time_range - description: The object ID to the user. Can be one of LocalUserObjGroup, UserGroupObj, UserObj. Can be received with existing commands; cisco-asa-list-local-user-group, cisco-asa-list-local-user, cisco-asa-list-user-object. name: user - auto: PREDEFINED description: The type of the user. Can be one of LocalUserObjGroup, UserGroupObj, UserObj. name: user_kind predefined: - LocalUserObjGroup - UserGroupObj - UserObj - description: Source security group in the ace. Possible values are SecurityName, SecurityTag and SecurityObjGroup. Can be received with the existing command cisco-asa-list-security-object-group. name: source_security - auto: PREDEFINED description: The source security type. name: source_security_kind predefined: - SecurityName - SecurityTag - SecurityObjGroup - description: Destination security group in the ace. Possible values are SecurityName, SecurityTag and SecurityObjGroup. Can be received with the existing command cisco-asa-list-security-object-group. name: destination_security - auto: PREDEFINED description: The destination security type. name: destination_security_kind predefined: - SecurityName - SecurityTag - SecurityObjGroup description: Creates a rule. name: cisco-asa-create-rule outputs: - contextPath: CiscoASA.Rules.Source description: The rule's source. type: String - contextPath: CiscoASA.Rules.Dest description: The rule's destination. type: String - contextPath: CiscoASA.Rules.InterfaceType description: The interface type. Can be "In", "Out", or "Global". type: String - contextPath: CiscoASA.Rules.IsActive description: Whether the rule is active. type: Boolean - contextPath: CiscoASA.Rules.Interface description: The name of the interface. type: String - contextPath: CiscoASA.Rules.Position description: The position of the rule. type: Number - contextPath: CiscoASA.Rules.ID description: The rule ID. type: String - contextPath: CiscoASA.Rules.Remarks description: A list of all rule remarks. type: Unknown - contextPath: CiscoASA.Rules.Permit description: Whether the rule permits traffic from source to destination. type: Boolean - contextPath: CiscoASA.Rules.DestService description: The destination service. type: String - contextPath: CiscoASA.Rules.SourceService description: The source service. type: String - contextPath: CiscoASA.Rules.SourceKind description: One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. type: String - contextPath: CiscoASA.Rules.DestKind description: One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. type: String - contextPath: CiscoASA.Rules.SourceSecurity.kind description: The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.SourceSecurity.value description: The value of the SecurityName or SecurityTag. type: String - contextPath: CiscoASA.Rules.SourceSecurity.objectId description: The object ID of objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.kind description: The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.value description: The value of the SecurityName or SecurityTag. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.objectId description: The object ID of objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.User.kind description: One of AnyUser, NoneUser, objectRef#LocalUserObjGroup, objectRef#UserGroupObj, objectRef#UserObj. type: String - contextPath: CiscoASA.Rules.User.value description: The user value. type: String - contextPath: CiscoASA.Rules.User.objectId description: The object ID of the user. type: String - contextPath: CiscoASA.Rules.TimeRange.kind description: The object reference type or the actual TimeRange value. type: String - contextPath: CiscoASA.Rules.TimeRange.value description: The value of the time range. type: String - contextPath: CiscoASA.Rules.TimeRange.objectId description: The object ID of the time range. type: String - arguments: - description: The rule ID. name: rule_id required: true - description: The name of the interface. name: interface_name - auto: PREDEFINED description: The interface type. Can be "In", "Out", or "Global". name: interface_type predefined: - In - Out - Global required: true description: Deletes a rule. name: cisco-asa-delete-rule - arguments: - auto: PREDEFINED description: The interface type. Can be "In", "Out", or "Global". name: interface_type predefined: - In - Out - Global required: true - description: The interface name. name: interface_name - description: The rule ID. name: rule_id required: true - auto: PREDEFINED description: Whether the rule will be active. If True, will be active. name: active predefined: - 'True' - 'False' defaultValue: 'True' - description: The log level of the rule. name: log_level - description: 'The position the rule will be in. ' name: position - description: A list of remarks for the rule. isArray: true name: remarks - auto: PREDEFINED description: True if the rule is a permit. name: permit predefined: - 'True' - 'False' - description: The destination. Can be the value of an IPv4, an address block, or the name of a network object. name: destination - description: The source. Can be the value of an IPv4, an address block, or the name of a network object. name: source - description: The service of the rule. name: service - auto: PREDEFINED description: The destination address type in the ace. name: destination_kind predefined: - AnyIPAddress - IPv4Address - IPv4FQDN - IPv4Network - IPv4Range - IPv6Address - IPv6FQDN - IPv6Network - IPv6Range - SecurityName - SecurityTag - interfaceIP - NetworkObj - NetworkObjGroup - auto: PREDEFINED description: The source address type in the ace. name: source_kind predefined: - AnyIPAddress - IPv4Address - IPv4FQDN - IPv4Network - IPv4Range - IPv6Address - IPv6FQDN - IPv6Network - IPv6Range - SecurityName - SecurityTag - interfaceIP - NetworkObj - NetworkObjGroup - auto: PREDEFINED description: The source service type. name: service_kind predefined: - AnyService - ICMP6Service - ICMPService - NetworkProtocol - NetworkServiceGroups - NetworkServiceObjects - TcpUdpService - description: The destination service value. name: destination_service - auto: PREDEFINED description: The destination service type. name: destination_service_kind predefined: - AnyService - ICMP6Service - ICMPService - NetworkProtocol - NetworkServiceGroups - NetworkServiceObjects - TcpUdpService - auto: PREDEFINED description: Object ID of for the time range object. Can be received with the command cisco-asa-list-time-range. name: time_range - description: The object ID to the user. Can be one of LocalUserObjGroup, UserGroupObj, UserObj. Can be received with existing commands; cisco-asa-list-local-user-group, cisco-asa-list-local-user, cisco-asa-list-user-object. name: user - auto: PREDEFINED description: The type of the user. name: user_kind predefined: - LocalUserObjGroup - UserGroupObj - UserObj - description: Source security group in the ace. Possible values are SecurityName, SecurityTag and SecurityObjGroup. Can be received with the existing command cisco-asa-list-security-object-group. name: source_security - auto: PREDEFINED description: The source security type. name: source_security_kind predefined: - SecurityName - SecurityTag - SecurityObjGroup - description: Destination security group in the ace. Possible values are SecurityName, SecurityTag and SecurityObjGroup. Can be received with the existing command cisco-asa-list-security-object-group. name: destination_security - auto: PREDEFINED description: The destination security type. name: destination_security_kind predefined: - SecurityName - SecurityTag - SecurityObjGroup description: Updates an existing rule. name: cisco-asa-edit-rule outputs: - contextPath: CiscoASA.Rules.Source description: The rule's source. type: String - contextPath: CiscoASA.Rules.Dest description: The rule's destination. type: String - contextPath: CiscoASA.Rules.InterfaceType description: The interface type. Can be "In", "Out", or "Global". type: String - contextPath: CiscoASA.Rules.IsActive description: Whether the rule is active. type: Boolean - contextPath: CiscoASA.Rules.Interface description: The name of the interface. type: String - contextPath: CiscoASA.Rules.Position description: The position of the rule. type: Number - contextPath: CiscoASA.Rules.ID description: The rule ID. type: String - contextPath: CiscoASA.Rules.Remarks description: A list of all rule remarks. type: Unknown - contextPath: CiscoASA.Rules.Permit description: Whether the rule permits traffic from source to destination. type: Boolean - contextPath: CiscoASA.Rules.DestService description: The destination service. type: String - contextPath: CiscoASA.Rules.SourceService description: The source service. type: String - contextPath: CiscoASA.Rules.SourceKind description: One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. type: String - contextPath: CiscoASA.Rules.DestKind description: One of AnyIPAddress, IPv4Address, IPv4FQDN, IPv4Network, IPv4Range, IPv6Address, IPv6FQDN, IPv6Network, IPv6Range, SecurityName, SecurityTag, interfaceIP, objectRef#NetworkObj, objectRef#NetworkObjGroup. type: String - contextPath: CiscoASA.Rules.SourceSecurity.kind description: The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.SourceSecurity.value description: The value of the SecurityName or SecurityTag. type: String - contextPath: CiscoASA.Rules.SourceSecurity.objectId description: The object ID of objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.kind description: The type of the security group; SecurityName, SecurityTag, objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.value description: The value of the SecurityName or SecurityTag. type: String - contextPath: CiscoASA.Rules.DestinationSecurity.objectId description: The object ID of objectRef#SecurityObjGroup. type: String - contextPath: CiscoASA.Rules.User.kind description: One of AnyUser, NoneUser, objectRef#LocalUserObjGroup, objectRef#UserGroupObj, objectRef#UserObj. type: String - contextPath: CiscoASA.Rules.User.value description: The user value. type: String - contextPath: CiscoASA.Rules.User.objectId description: The object ID of the user. type: String - contextPath: CiscoASA.Rules.TimeRange.kind description: The object reference type or the actual TimeRange value. type: String - contextPath: CiscoASA.Rules.TimeRange.value description: The value of the time range. type: String - contextPath: CiscoASA.Rules.TimeRange.objectId description: The object ID of the time range. type: String - arguments: - description: A comma-separated list of network object names for which to get the network. isArray: true name: object_name - description: A comma-separated list of object IDs for which to get the network object. isArray: true name: object_id description: Gets a list all configured network objects. name: cisco-asa-list-network-objects outputs: - contextPath: CiscoASA.NetworkObject.ID description: The ID of the network object. type: String - contextPath: CiscoASA.NetworkObject.Host description: The host information of the network object. type: String - contextPath: CiscoASA.NetworkObject.Description description: A description of the network object. type: String - contextPath: CiscoASA.NetworkObject.Name description: The name of the network object. type: String - arguments: - auto: PREDEFINED description: The type of network object to create. name: object_type predefined: - IPv4 - IP-Network required: true - description: The name of the object to create. name: object_name required: true - description: The value of the network object to create. name: object_value required: true description: Creates a network object. name: cisco-asa-create-network-object outputs: - contextPath: CiscoASA.NetworkObject.ID description: The ID of the network object. type: String - contextPath: CiscoASA.NetworkObject.Host description: The host information of the network object. type: String - contextPath: CiscoASA.NetworkObject.Description description: A description of the network object, if exists. type: String - contextPath: CiscoASA.NetworkObject.Name description: The name of the network object. type: String - description: Gets a list of all interfaces. name: cisco-asa-list-interfaces outputs: - contextPath: CiscoASA.Interface.ID description: The interface ID. type: String - contextPath: CiscoASA.Interface.Name description: The interface name. type: String - contextPath: CiscoASA.Interface.Type description: The type of interface. type: String dockerimage: demisto/python3:3.12.13.10116658 runonce: false script: '-' type: python subtype: python3 fromversion: 5.0.0 tests: - No tests (auto formatted)