category: Utilities provider: Trellix commonfields: id: McAfeeNSMv2 version: -1 configuration: - display: 'URL (for example: https://192.168.0.1:5000)' name: url required: true type: 0 defaultvalue: "" section: Connect - display: User Name name: credentials required: true type: 9 section: Connect - display: Product Version name: version type: 15 defaultvalue: V9x options: - V9x - V10x section: Connect required: false - display: Trust any certificate (not secure) name: insecure type: 8 section: Connect advanced: true required: false - display: Use system proxy settings name: proxy type: 8 section: Connect advanced: true required: false description: McAfee Network Security Manager gives you real-time visibility and control over all McAfee intrusion prevention systems deployed across your network. display: 'McAfee NSM v2' name: McAfeeNSMv2 script: commands: - name: nsm-list-domain-firewall-policy description: Gets the list of firewall policies defined in a particular domain. arguments: - name: domain_id required: true description: The ID of the domain. To get the domain_id, use the !nsm-get-domains command. - name: limit description: The maximum number of records to return. defaultValue: 50 - name: page description: The specific result page to display. - name: page_size description: The number of records in a page. outputs: - contextPath: NSM.Policy.policyId description: The ID of the policy. type: Number - contextPath: NSM.Policy.policyName description: Name of the firewall policy. type: String - contextPath: NSM.Policy.domainId description: The ID of the domain. type: Number - contextPath: NSM.Policy.visibleToChild description: Whether the policy is visible to child domains. type: Boolean - contextPath: NSM.Policy.description description: Policy description. type: String - contextPath: NSM.Policy.isEditable description: Whether the policy is editable. type: Boolean - contextPath: NSM.Policy.policyType description: Policy type. Can be "ADVANCED" or "CLASSIC". type: String - contextPath: NSM.Policy.policyVersion description: Policy version. type: Number - contextPath: NSM.Policy.lastModUser description: Last user who modified the policy. type: String - name: nsm-get-firewall-policy description: Gets the firewall policy details. arguments: - name: policy_id required: true description: The ID of the policy. To get the policy_id, use the !nsm-list-domain-firewall-policy command. - name: include_rule_objects description: Whether to insert the rule objects that are linked to the policy in the context. auto: PREDEFINED predefined: - 'true' - 'false' defaultValue: 'false' outputs: - contextPath: NSM.Policy.FirewallPolicyId description: Unique firewall policy ID. type: Number - contextPath: NSM.Policy.Name description: Policy name. type: String - contextPath: NSM.Policy.DomainId description: ID of the domain to which this firewall policy belongs. type: Number - contextPath: NSM.Policy.VisibleToChild description: Whether the policy is visible to a child domain. type: Boolean - contextPath: NSM.Policy.Description description: Firewall policy description. type: String - contextPath: NSM.Policy.LastModifiedTime description: Last modified time of the firewall Policy. type: Date - contextPath: NSM.Policy.IsEditable description: Whether the policy is editable. type: Boolean - contextPath: NSM.Policy.PolicyType description: Policy type. Can be "Advanced" / "Classic". type: String - contextPath: NSM.Policy.PolicyVersion description: Policy version. type: Number - contextPath: NSM.Policy.LastModifiedUser description: Last user user modified the policy. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.Description description: Rule description. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.Enabled description: Whether the rule is enabled. type: Boolean - contextPath: NSM.Policy.MemberDetails.MemberRuleList.Response description: Action to be performed if the traffic matches this rule. Can be "Scan" / "Drop" / "Deny" / "Ignore" / "Stateless Ignore" / "Stateless Drop" / "Require Authentication". type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.IsLogging description: Whether logging is enabled for this rule. type: Boolean - contextPath: NSM.Policy.MemberDetails.MemberRuleList.Direction description: Rule direction. Can be "Inbound" / "Outbound" / "Either". type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.SourceAddressObjectList.RuleObjectId description: Unique rule object ID. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.SourceAddressObjectList.Name description: Rule object name. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.SourceAddressObjectList.RuleObjectType description: Source or destination mode. Can be "Endpoint IP V.4" / "Range IP V.4" / "Network IP V.4" / "Endpoint IP V.6" / "Range IP V.6" / "Network IP V.6". type: Unknown - contextPath: NSM.Policy.MemberDetails.MemberRuleList.DestinationAddressObjectList.RuleObjectId description: Unique rule object ID. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.DestinationAddressObjectList.Name description: Rule object name. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.DestinationAddressObjectList.RuleObjectType description: Source or destination mode. Can be "Endpoint IP V.4" / "Range IP V.4" / "Endpoint IP V.6" / "Range IP V.6" / "Network IP V.6". type: Unknown - contextPath: NSM.Policy.MemberDetails.MemberRuleList.SourceUserObjectList.RuleObjectId description: Unique rule object ID. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.SourceUserObjectList.Name description: Rule object name. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.SourceUserObjectList.RuleObjectType description: Source user. Can be "USER" / "USER_GROUP". type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.ServiceObjectList.RuleObjectId description: Unique service rule object ID. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.ServiceObjectList.Name description: Rule object name. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.ServiceObjectList.RuleObjectType description: Service/ application mode. Can be "APPLICATION" / "APPLICATION_GROUP" / "APPLICATION_ON_CUSTOM_PORT" / "SERVICE" / "SERVICE_GROUP". type: Unknown - contextPath: NSM.Policy.MemberDetails.MemberRuleList.ServiceObjectList.ApplicationType description: Application type. Can be "DEFAULT" / "CUSTOM". type: Unknown - contextPath: NSM.Policy.MemberDetails.MemberRuleList.ApplicationObjectList.RuleObjectId description: Unique service rule object ID. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.ApplicationObjectList.Name description: Rule object name. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.ApplicationObjectList.RuleObjectType description: Service/ application mode. Can be "APPLICATION" / "APPLICATION_GROUP" / "APPLICATION_ON_CUSTOM_PORT" / "SERVICE" / "SERVICE_GROUP". type: Unknown - contextPath: NSM.Policy.MemberDetails.MemberRuleList.ApplicationObjectList.ApplicationType description: Application type. Can be "DEFAULT" / "CUSTOM". type: Unknown - contextPath: NSM.Policy.MemberDetails.MemberRuleList.TimeObjectList.RuleObjectId description: Unique service rule object ID. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.TimeObjectList.Name description: Rule object name. type: String - contextPath: NSM.Policy.MemberDetails.MemberRuleList.TimeObjectList.RuleObjectType description: Time mode. Can be "FINITE_TIME_PERIOD" / "RECURRING_TIME_PERIOD" / "RECURRING_TIME_PERIOD_GROUP". type: Unknown - name: nsm-create-firewall-policy description: Adds a new firewall policy and access rules. You have to provide at lease one of the source/destination rule objects. If you provide the id or type of the source/destination rule object, you must provide the matching type or id the source/destination rule object as well. arguments: - name: domain required: true description: The ID of the domain. To get the domain ID, use the !nsm-get-domains command. - name: name required: true description: The policy name. - name: visible_to_child description: Whether the policy is visible to the child domain. auto: PREDEFINED predefined: - yes - no defaultValue: yes - name: description required: true description: The description of the policy. - name: is_editable description: Whether the policy is editable. auto: PREDEFINED predefined: - yes - no defaultValue: yes - name: policy_type auto: PREDEFINED description: The type of the policy. predefined: - Advanced - Classic required: true - name: rule_description required: true description: The rule description. - name: response auto: PREDEFINED description: Action to be performed if the traffic matches this rule. predefined: - Scan - Drop - Deny - Ignore - Stateless Ignore - Stateless Drop - Require Authentication required: true - name: rule_enabled description: Whether the rule is enabled. auto: PREDEFINED predefined: - yes - no defaultValue: yes - name: direction auto: PREDEFINED description: The direction of the rule. predefined: - Inbound - Outbound - Either required: true - name: source_rule_object_id description: The ID of the rule connected to the policy. To get the rule_object_id use the command '!nsm-list-domain-rule-object'. - name: source_rule_object_type auto: PREDEFINED description: The type of the rule connected to the policy. To get the rule_object_type use the command '!nsm-list-domain-rule-object'. predefined: - Endpoint IP V.4 - Range IP V.4 - Network IP V.4 - Endpoint IP V.6 - Range IP V.6 - Network IP V.6 - name: destination_rule_object_id description: The ID of the rule connected to the policy. To get the rule_object_id use the command '!nsm-list-domain-rule-object'. - name: destination_rule_object_type auto: PREDEFINED description: The type of the rule connected to the policy. To get the rule_object_type use the command '!nsm-list-domain-rule-object'. predefined: - Endpoint IP V.4 - Range IP V.4 - Network IP V.4 - Endpoint IP V.6 - Range IP V.6 - Network IP V.6 outputs: - contextPath: NSM.Policy.FirewallPolicyId description: The ID of the newly created firewall policy. type: Number - name: nsm-update-firewall-policy description: Updates the firewall policy details. If the argument is_overwrite=true, the new values of the provided addresses will replace the existing values, otherwise the addresses will be added to them. If you want to delete a rule, enter is_overwrite=true and the relevant rule_object_id=-1. If is_overwrite=false and there is no value in one of the rules (source or destination), their value will be as before. If is_overwrite=true, at least one of the rules (source or destination) must be provided. If you provide the id or type of the source/destination rule object, you must provide the matching type or id the source/destination rule object as well. arguments: - name: policy_id required: true description: The ID of the policy. To get the policy ID, use the !nsm-list-domain-firewall-policy. - name: domain description: The ID of the domain. To get the domain ID, use the !nsm-get-domains command. - name: name description: The policy name. - name: visible_to_child description: Whether the policy is visible to the child domain. auto: PREDEFINED predefined: - yes - no defaultValue: yes - name: description description: The description of the policy. - name: is_editable description: Whether the policy is editable. auto: PREDEFINED predefined: - yes - no - name: policy_type auto: PREDEFINED description: The type of the policy. predefined: - Advanced - Classic - name: rule_description description: The rule description. - name: response auto: PREDEFINED description: Action to be performed if the traffic matches this rule. predefined: - Scan - Drop - Deny - Ignore - Stateless Ignore - Stateless Drop - Require Authentication - name: rule_enabled description: Whether the rule is enabled. auto: PREDEFINED predefined: - yes - no defaultValue: yes - name: direction auto: PREDEFINED description: The direction of the rule. predefined: - Inbound - Outbound - Either - name: source_rule_object_id description: The ID of the rule connected to the policy. To get the rule_object_id use the command '!nsm-list-domain-rule-object'. - name: source_rule_object_type auto: PREDEFINED description: The type of the rule connected to the policy. To get the rule_object_type use the command '!nsm-list-domain-rule-object'. predefined: - Endpoint IP V.4 - Range IP V.4 - Network IP V.4 - Endpoint IP V.6 - Range IP V.6 - Network IP V.6 - name: destination_rule_object_id description: The ID of the rule connected to the policy. To get the rule_object_id use the command '!nsm-list-domain-rule-object'. - name: destination_rule_object_type auto: PREDEFINED description: The type of the rule connected to the policy. To get the rule_object_type use the command '!nsm-list-domain-rule-object'. predefined: - Endpoint IP V.4 - Range IP V.4 - Network IP V.4 - Endpoint IP V.6 - Range IP V.6 - Network IP V.6 - name: is_overwrite description: Whether the new addresses that were provided in the update processes will override the current ones or will be added to them. auto: PREDEFINED predefined: - 'true' - 'false' - name: nsm-delete-firewall-policy description: Deletes the specified firewall policy. arguments: - name: policy_id required: true description: The ID of the policy to delete. To get the policy ID, use the !nsm-list-domain-firewall-policy. - name: nsm-list-domain-rule-object description: Gets the list of rule objects defined in a particular domain. arguments: - name: domain_id required: true description: The ID of the domain. To get the domain ID, use the !nsm-get-domains command. - name: type auto: PREDEFINED description: The type of the rule. predefined: - Endpoint IP V.4 - Range IP V.4 - Network IP V.4 - Endpoint IP V.6 - Range IP V.6 - Network IP V.6 - All defaultValue: All - name: limit description: The maximum number of records to return. defaultValue: 50 - name: page description: The specific result page to display. - name: page_size description: The number of records in a page. outputs: - contextPath: NSM.Rule.ruleobjId description: The ID of the rule object. type: String - contextPath: NSM.Rule.ruleobjType description: The type of the rule object. type: String - contextPath: NSM.Rule.name description: The name of the rule object. type: String - contextPath: NSM.Rule.description description: The description of the rule object. type: String - contextPath: NSM.Rule.domain description: The name of the rule object. type: Number - contextPath: NSM.Rule.visibleToChild description: Whether the rule is visible to child domains. type: Boolean - contextPath: NSM.Rule.hostCriticality description: The critical level of the host. type: String - contextPath: NSM.Rule.ApplicationGroup description: Application Group object. Should be defined if ruleobjType is "APPLICATION_GROUP". type: Unknown - contextPath: NSM.Rule.ApplicationOnCustomPort description: Application defined on Custom Port object. Should be defined if ruleobjType is "APPLICATION_ON_CUSTOM_PORT". type: Unknown - contextPath: NSM.Rule.FiniteTimePeriod description: Finite Time Period object. Should be defined if ruleobjType is "FINITE_TIME_PERIOD". type: Unknown - contextPath: NSM.Rule.HostIPv4 description: Host IPv4 Address object. Should be defined if ruleobjType is "HOST_IPV_4". type: Unknown - contextPath: NSM.Rule.HostIPv6 description: Host IPv6 Address object. Should be defined if ruleobjType is "HOST_IPV_6". type: Unknown - contextPath: NSM.Rule.HostDNSName description: Host DNS Name object. Should be defined if ruleobjType is "HOST_DNS_NAME". type: Unknown - contextPath: NSM.Rule.IPv4AddressRange description: IPv4 Address Range object. Should be defined if ruleobjType is "IPV_4_ADDRESS_RANGE". type: Unknown - contextPath: NSM.Rule.IPv6AddressRange description: IPv6 Address Range object. Should be defined if ruleobjType is "IPV_6_ADDRESS_RANGE". type: Unknown - contextPath: NSM.Rule.Network_IPV_4 description: IPv4 Network object. Should be defined if ruleobjType is "NETWORK_IPV_4. type: Unknown - contextPath: NSM.Rule.Network_IPV_6 description: IPv6 Network object. Should be defined if ruleobjType is "NETWORK_IPV_6". type: String - contextPath: NSM.Rule.NetworkGroup description: Network Group object. Should be defined if ruleobjType is "NETWORK_GROUP". type: Unknown - contextPath: NSM.Rule.RecurringTimePeriod description: Recurring Time Period object. Should be defined if ruleobjType is "RECURRING_TIME_PERIOD". type: Unknown - contextPath: NSM.Rule.RecurringTimePeriodGroup description: Recurring Time Period Group object. Should be defined if ruleobjType is "RECURRING_TIME_PERIOD_GROUP". type: Unknown - contextPath: NSM.Rule.Service description: Service object. Should be defined if ruleobjType is "CUSTOM_SERVICE". type: Unknown - contextPath: NSM.Rule.ServiceGroup description: Service Group object. Should be defined if ruleobjType is "SERVICE_GROUP". type: Unknown - contextPath: NSM.Rule.ServiceRange description: Service Range object. Should be defined if ruleobjType is "SERVICE_RANGE". type: Unknown - contextPath: NSM.Rule.IPv6AddressRange.IPV6RangeList description: List of IPv6 Address Range. type: String - contextPath: NSM.Rule.HostIPv6.hostIPv6AddressList description: Host IPv6 address list. type: String - contextPath: NSM.Rule.Network_IPV_4.networkIPV4List description: Network IPV4 list. type: String - contextPath: NSM.Rule.IPv4AddressRange.IPV4RangeList description: List of IPv4 address range. type: String - contextPath: NSM.Rule.HostIPv4.hostIPv4AddressList description: Host IPv4 address list. type: String - contextPath: NSM.Rule.Network_IPV_6.networkIPV6List description: Network IPV6 list. type: String - name: nsm-get-rule-object description: Gets the details of a rule object. arguments: - name: rule_id required: true description: The ID of the rule object. To get the rule object ID, use the !nsm-list-domain-rule-object. outputs: - contextPath: NSM.Rule.ruleobjId description: The ID of the rule object. type: String - contextPath: NSM.Rule.ruleobjType description: The type of the rule object. type: String - contextPath: NSM.Rule.name description: The name of the rule object. type: String - contextPath: NSM.Rule.description description: The description of the rule object. type: String - contextPath: NSM.Rule.domain description: The name of the rule object. type: Number - contextPath: NSM.Rule.visibleToChild description: Whether the rule is visible to child domains. type: Boolean - contextPath: NSM.Rule.ApplicationGroup description: Application Group object. Should be defined if ruleobjType is "APPLICATION_GROUP". type: Unknown - contextPath: NSM.Rule.ApplicationOnCustomPort description: Application defined on Custom Port object. Should be defined if ruleobjType is "APPLICATION_ON_CUSTOM_PORT". type: Unknown - contextPath: NSM.Rule.FiniteTimePeriod description: Finite Time Period object. Should be defined if ruleobjType is "FINITE_TIME_PERIOD". type: Unknown - contextPath: NSM.Rule.HostIPv4 description: Host IPv4 Address object. Should be defined if ruleobjType is "HOST_IPV_4". type: Unknown - contextPath: NSM.Rule.HostIPv6 description: Host IPv6 Address object. Should be defined if ruleobjType is "HOST_IPV_6". type: Unknown - contextPath: NSM.Rule.HostDNSName description: Host DNS Name object. Should be defined if ruleobjType is "HOST_DNS_NAME". type: Unknown - contextPath: NSM.Rule.IPv4AddressRange description: IPv4 Address Range object. Should be defined if ruleobjType is "IPV_4_ADDRESS_RANGE". type: Unknown - contextPath: NSM.Rule.IPv6AddressRange description: IPv6 Address Range object. Should be defined if ruleobjType is "IPV_6_ADDRESS_RANGE". type: Unknown - contextPath: NSM.Rule.Network_IPV_4 description: IPv4 Network object. Should be defined if ruleobjType is "NETWORK_IPV_4. type: Unknown - contextPath: NSM.Rule.Network_IPV_6 description: IPv6 Network object. Should be defined if ruleobjType is "NETWORK_IPV_6". type: String - contextPath: NSM.Rule.NetworkGroup description: Network Group object. Should be defined if ruleobjType is "NETWORK_GROUP". type: Unknown - contextPath: NSM.Rule.RecurringTimePeriod description: Recurring Time Period object. Should be defined if ruleobjType is "RECURRING_TIME_PERIOD". type: Unknown - contextPath: NSM.Rule.RecurringTimePeriodGroup description: Recurring Time Period Group object. Should be defined if ruleobjType is "RECURRING_TIME_PERIOD_GROUP". type: Unknown - contextPath: NSM.Rule.Service description: Service object. Should be defined if ruleobjType is "CUSTOM_SERVICE". type: Unknown - contextPath: NSM.Rule.ServiceGroup description: Service Group object. Should be defined if ruleobjType is "SERVICE_GROUP". type: Unknown - contextPath: NSM.Rule.ServiceRange description: Service Range object. Should be defined if ruleobjType is "SERVICE_RANGE". type: Unknown - contextPath: NSM.Rule.IPv6AddressRange.IPV6RangeList description: List of IPv6 Address Range. type: String - contextPath: NSM.Rule.HostIPv6.hostIPv6AddressList description: Host IPv6 address list. type: String - contextPath: NSM.Rule.Network_IPV_4.networkIPV4List description: Network IPV4 list. type: String - contextPath: NSM.Rule.Network_IPV_6.networkIPV6List description: Network IPV6 list. type: String - contextPath: NSM.Rule.IPv4AddressRange.IPV4RangeList description: List of IPv4 Address Range. type: String - contextPath: NSM.Rule.HostIPv4.hostIPv4AddressList description: Host IPv4 address list. type: String - name: nsm-create-rule-object description: Adds a new rule object. If the type is “Endpoint IP V.X” or “Network IP V.X”, only the argument “address_ip_v.X” must contain a value. If the type is “Range IP V.X”, only the arguments “from_address_ip_v.X”, “to_address_ip_v.X” must contain a value. Where X is 4 or 6 respectively. arguments: - name: domain required: true description: The ID of the domain. To get the domain ID, use the !nsm-get-domains command. - name: rule_object_type auto: PREDEFINED description: The type of the rule. If the type is “Endpoint IP V.X” or “Network IP V.X”, only the argument “address_ip_v.X” must contain a value. If the type is “Range IP V.X”, only the arguments “from_address_ip_v.X”, “to_address_ip_v.X” must contain a value, where X is 4 or 6 respectively. predefined: - Endpoint IP V.4 - Range IP V.4 - Network IP V.4 - Endpoint IP V.6 - Range IP V.6 - Network IP V.6 required: true - name: name required: true description: The rule object name. - name: visible_to_child description: Whether the rule object is visible to the child domain. auto: PREDEFINED predefined: - yes - no defaultValue: yes - name: description description: The description of the rule object. - name: address_ip_v.4 description: List of IPv4 Host Address, separated by a comma. - name: from_address_ip_v.4 description: Start of the IPv4 range. - name: to_address_ip_v.4 description: End of the IPv4 range. - name: address_ip_v.6 description: List of IPv6 host addresses, separated by a comma. - name: from_address_ip_v.6 description: Start of the IPv6 range. - name: to_address_ip_v.6 description: End of the IPv6 range. - name: state description: "Whether to enable or disable the rule object.\nNote: This argument is only relevant to version 10x." defaultValue: Enabled auto: PREDEFINED predefined: - Disabled - Enabled outputs: - contextPath: NSM.Rule.ruleobjId description: The ID of the newly created rule object. type: Number - name: nsm-update-rule-object description: Updates a Rule object. In case of address rule update, if the rule type is “Endpoint IP V.X” or “Network IP V.X”, only the argument “address_ip_v.X” should contain a value. If the type is “Range IP V.X”, only the arguments “from_address_ip_v.X”, “to_address_ip_v.X” should contain a value, where X is 4 or 6 respectively. arguments: - name: domain required: true description: The ID of the domain. To get the domain ID, use the !nsm-get-domains command. - name: rule_id description: The ID of the rule. To get the rule object ID, use the !nsm-list-domain-rule-object. required: true - name: name description: The rule object name. - name: visible_to_child description: Whether the rule object is visible to the child domain. auto: PREDEFINED predefined: - yes - no defaultValue: yes - name: description description: The description of the rule object. - name: address_ip_v.4 description: List of IPv4 host addresses, separated by a comma. - name: from_address_ip_v.4 description: Start of the IPv4 range. - name: to_address_ip_v.4 description: End of the IPv4 range. - name: address_ip_v.6 description: List of IPv6 host addresses, separated by a comma. - name: from_address_ip_v.6 description: Start of the IPv6 range. - name: to_address_ip_v.6 description: End of the IPv6 range. - name: is_overwrite description: Whether the new addresses that were provided in the update processes will override the current ones or will be added to them. The default is false, and the addresses will be added. auto: PREDEFINED predefined: - 'true' - 'false' - name: state description: "Whether to enable or disable the rule object.\nNote: This argument is only relevant to version 10x, and can be used for adding a new address. Existing address states cannot be modified." defaultValue: Enabled auto: PREDEFINED predefined: - Disabled - Enabled - name: nsm-delete-rule-object description: Deletes a rule object. arguments: - name: rule_id required: true description: The ID of the rule object. To get the rule object ID, use the !nsm-list-domain-rule-object. - name: nsm-get-alerts description: Retrieves the alerts. arguments: - name: limit description: The maximum number of records to return. defaultValue: 50 - name: page description: The specific result page to display. - name: page_size description: The number of records in a page. - name: time_period auto: PREDEFINED predefined: - LAST_5_MINUTES - LAST_1_HOUR - LAST_6_HOURS - LAST_12_HOURS - LAST_24_HOURS - LAST_7_DAYS - LAST_14_DAYS - CUSTOM description: Time period. defaultValue: LAST_7_DAYS - name: start_time description: Start time in "mm/dd/yyyy HH:MM" format. Used for custom time only. - name: end_time description: End time in "mm/dd/yyyy HH:MM" format. Used for custom time only. - name: state auto: PREDEFINED predefined: - ANY - Acknowledged - Unacknowledged description: Alert state. defaultValue: ANY - name: search description: Search string in alert details. - name: filter description: 'Filter alert by fields. For example: "name:hello;direction:Inbound,Outbound;attackcount:>3,<4". To use the "name" field in the filter, enter only one name in each command run. Filter on the following columns is allowed- name, assignTo, application, layer7Data, result, attackCount, relevance, alertId, direction, device, domain, interface, attackSeverity, nspId, btp, attackCategory, malwarefileName, malwarefileHash, malwareName, malwareConfidence, malwareEngine ,executableName, executableHash, executableConfidenceName, attackerIPAddress, attackerPort, attackerRisk, attackerProxyIP, attackerHostname, targetIPAddress, targetPort, targetRisk, targetProxyIP, targetHostname, botnetFamily.' - name: domain_id description: The ID of the domain. To get the domain_id, use the !nsm-get-domains command. defaultValue: 0 outputs: - contextPath: NSM.Alerts.ID description: Alert ID. type: number - contextPath: NSM.Alerts.Name description: Alert name. type: String - contextPath: NSM.Alerts.uniqueAlertId description: Unique alert ID. type: String - contextPath: NSM.Alerts.State description: Alert state (Acknowledged,Unacknowledged). type: String - contextPath: NSM.Alerts.Assignee description: Alert assignee. type: String - contextPath: NSM.Alerts.CreatedTime description: Alert creation time. type: String - contextPath: NSM.Alerts.AttackSeverity description: Alert severity. type: String - contextPath: NSM.Alerts.Event.time description: The creation time of the event that triggered the alert. type: Date - contextPath: NSM.Alerts.Event.direction description: The direction of the event (Outbound, Inbound). type: String - contextPath: NSM.Alerts.Event.result description: The result of the event. type: String - contextPath: NSM.Alerts.Event.attackCount description: Attack count. type: Number - contextPath: NSM.Alerts.Event.relevance description: The event relevance. type: String - contextPath: NSM.Alerts.Event.alertId description: Alert ID. type: String - contextPath: NSM.Alerts.Event.domain description: The event's domain. type: String - contextPath: NSM.Alerts.Event.interface description: The event's interface. type: String - contextPath: NSM.Alerts.Event.device description: The relevant device. type: String - contextPath: NSM.Alerts.Attack.nspId description: Network Security Platform (NSP) ID. type: String - contextPath: NSM.Alerts.Attack.btp description: Benign Trigger Probability (BTP). type: String - contextPath: NSM.Alerts.Attack.attackCategory description: The attack category. type: String - contextPath: NSM.Alerts.Attacker.ipAddrs description: The attacker IP address. type: String - contextPath: NSM.Alerts.Attacker.port description: The attacker port. type: Number - contextPath: NSM.Alerts.Attacker.hostName description: The attacker host name. type: String - contextPath: NSM.Alerts.Attacker.country description: The attacker country. type: String - contextPath: NSM.Alerts.Attacker.os description: The attacker operating system. type: Unknown - contextPath: NSM.Alerts.Attacker.vmName description: The attacker VM name. type: Unknown - contextPath: NSM.Alerts.Attacker.proxyIP description: The attacker proxy IP. type: String - contextPath: NSM.Alerts.Attacker.user description: The user. type: Unknown - contextPath: NSM.Alerts.Attacker.risk description: Attacker risk. type: String - contextPath: NSM.Alerts.Attacker.networkObject description: The attacker network object. type: Unknown - contextPath: NSM.Alerts.Target.ipAddrs description: The target IP address. type: String - contextPath: NSM.Alerts.Target.port description: The target port. type: Number - contextPath: NSM.Alerts.Target.hostName description: The target host name. type: String - contextPath: NSM.Alerts.Target.country description: The target country. type: String - contextPath: NSM.Alerts.Target.os description: The target operating system. type: Unknown - contextPath: NSM.Alerts.Target.vmName description: The target VM name. type: Unknown - contextPath: NSM.Alerts.Target.proxyIP description: The target proxy IP. type: String - contextPath: NSM.Alerts.Target.user description: The target user. type: Unknown - contextPath: NSM.Alerts.Target.risk description: The target risk. type: String - contextPath: NSM.Alerts.Target.networkObject description: The target network object. type: Unknown - contextPath: NSM.Alerts.MalwareFile.fileName description: The name of the malware file. type: String - contextPath: NSM.Alerts.MalwareFile.fileHash description: The file hash of the malware file. type: String - contextPath: NSM.Alerts.MalwareFile.fileSHA1Hash description: The malware file SHA1 hash. type: String - contextPath: NSM.Alerts.MalwareFile.fileSHA256Hash description: The file SHA256 hash of the malware file. type: Unknown - contextPath: NSM.Alerts.MalwareFile.malwareName description: The name of the malware. type: String - contextPath: NSM.Alerts.MalwareFile.malwareConfidence description: Malware confidence. type: String - contextPath: NSM.Alerts.MalwareFile.engine description: Malware file engine. type: String - contextPath: NSM.Alerts.MalwareFile.engineId description: Malware file engine ID. type: Number - contextPath: NSM.Alerts.MalwareFile.size description: The malware file size. type: Unknown - contextPath: NSM.Alerts.MalwareFile.description description: Malware file description. type: Unknown - contextPath: NSM.Alerts.MalwareFile.additionalReference description: Malware file additional reference. type: Unknown - contextPath: NSM.Alerts.MalwareFile.cveId description: Malware file CVE ID. type: Unknown - contextPath: NSM.Alerts.endpointExcutable.name description: Endpoint executable name. type: String - contextPath: NSM.Alerts.endpointExcutable.hash description: Endpoint executable hash. type: String - contextPath: NSM.Alerts.endpointExcutable.malwareConfidence description: Endpoint executable malware confidence. type: String - contextPath: NSM.Alerts.detection.managerId description: manager ID. type: Number - contextPath: NSM.Alerts.detection.manager description: The detection manager. type: Unknown - contextPath: NSM.Alerts.detection.domain description: Detection domain. type: String - contextPath: NSM.Alerts.detection.device description: Detection device. type: String - contextPath: NSM.Alerts.detection.deviceId description: Detection device ID. type: String - contextPath: NSM.Alerts.detection.interface description: Detection interface. type: String - contextPath: NSM.Alerts.Application description: The application associated to the alert. type: String - contextPath: NSM.Alerts.layer7Data description: Layer 7 information. type: String - contextPath: NSM.Alerts.EventResult description: Event result. type: String - contextPath: NSM.Alerts.SensorID description: Sensor ID. type: String - name: nsm-get-alert-details description: Retrieves the relevant alert details. arguments: - name: alert_id required: true description: Alert ID. In order to get the alert ID, use the command '!nsm-get-alerts' and use the output field “ID”. - name: sensor_id description: Sensor ID. In order to get the sensor ID, use the command '!nsm-get-alerts' and use the output field “SensorID”. required: true outputs: - contextPath: NSM.Alerts.ID description: Alert ID. type: number - contextPath: NSM.Alerts.Name description: Alert name. type: String - contextPath: NSM.Alerts.CreatedTime description: Alert creation time. type: String - contextPath: NSM.Alerts.uniqueAlertId description: Unique alert ID. type: String - contextPath: NSM.Alerts.State description: The state of the alert. type: String - contextPath: NSM.Alerts.Assignee description: Alert assignee. type: String - contextPath: NSM.Alerts.Event.application description: The event application. type: String - contextPath: NSM.Alerts.Event.protocol description: The event protocol. type: Unknown - contextPath: NSM.Alerts.Event.domain description: The domain of the event. type: String - contextPath: NSM.Alerts.Event.manager description: The event manager. type: Unknown - contextPath: NSM.Alerts.Event.device description: The event device. type: String - contextPath: NSM.Alerts.Event.deviceId description: The ID of the device related to the event. type: String - contextPath: NSM.Alerts.Event.interface description: The event interface. type: String - contextPath: NSM.Alerts.Event.matchedPolicy description: The policy that matched the event. type: String - contextPath: NSM.Alerts.Event.zone description: The event zone. type: Unknown - contextPath: NSM.Alerts.Event.vlan description: The event VLAN. type: String - contextPath: NSM.Alerts.Event.detection description: The event detection. type: String - contextPath: NSM.Alerts.Event.direction description: The event detection. type: String - contextPath: NSM.Alerts.CreatedTime description: The creation time of the event. type: Date - contextPath: NSM.Alerts.Event.direction description: The event direction. type: String - contextPath: NSM.Alerts.EventResult description: The event result. type: String - contextPath: NSM.Alerts.Event.attackCount description: Event attack count. type: Number - contextPath: NSM.Alerts.Event.relevance description: The relevance of the event. type: String - contextPath: NSM.Alerts.Event.alertId description: Alert ID. type: String - contextPath: NSM.Alerts.Attacker.ipAddrs description: Attacker IP addresses. type: Unknown - contextPath: NSM.Alerts.Attacker.port description: Attacker port. type: Number - contextPath: NSM.Alerts.Attacker.hostName description: Attacker host name. type: Unknown - contextPath: NSM.Alerts.Attacker.country description: Attacker country. type: Unknown - contextPath: NSM.Alerts.Attacker.os description: Attacker operating system. type: String - contextPath: NSM.Alerts.Attacker.vmName description: Attacker VM name. type: Unknown - contextPath: NSM.Alerts.Attacker.proxyIP description: Attacker proxy IP. type: Unknown - contextPath: NSM.Alerts.Attacker.user description: Attacker user. type: String - contextPath: NSM.Alerts.Attacker.risk description: Attacker risk. type: String - contextPath: NSM.Alerts.Attacker.networkObject description: Attacker network object. type: String - contextPath: NSM.Alerts.Target.ipAddrs description: Target IP address. type: Unknown - contextPath: NSM.Alerts.Target.port description: Target port. type: Number - contextPath: NSM.Alerts.Target.hostName description: Target host name. type: Unknown - contextPath: NSM.Alerts.Target.country description: Target country. type: Unknown - contextPath: NSM.Alerts.Target.os description: Target operating system. type: String - contextPath: NSM.Alerts.Target.vmName description: Target VM name. type: Unknown - contextPath: NSM.Alerts.Target.proxyIP description: Target proxy IP. type: Unknown - contextPath: NSM.Alerts.Target.user description: Target user. type: String - contextPath: NSM.Alerts.Target.risk description: Target risk. type: String - contextPath: NSM.Alerts.Target.networkObject description: Target network object. type: String - contextPath: NSM.Alerts.summary.source description: The source of the alert. type: Unknown - contextPath: NSM.Alerts.summary.destination description: The destination of the alert. type: Unknown - contextPath: NSM.Alerts.summary.zoombie description: Alert zoombie. type: Unknown - contextPath: NSM.Alerts.summary.cAndcServer description: The command and control server. type: Unknown - contextPath: NSM.Alerts.summary.fastFluxAgent description: Fast flux agent. type: Unknown - contextPath: NSM.Alerts.summary.attackedHIPEndpoint description: Attacked host intrusion prevention (HIP) endpoint. type: Unknown - contextPath: NSM.Alerts.summary.compromisedEndpoint description: Compromised endpoint. type: Unknown - contextPath: NSM.Alerts.Details.matchedSignature description: Matched signature. type: Unknown - contextPath: NSM.Alerts.MalwareFile description: Malware file. type: Unknown - contextPath: NSM.Alerts.Details.hostSweep description: Host sweep. type: Unknown - contextPath: NSM.Alerts.Details.portScan description: Port scan. type: Unknown - contextPath: NSM.Alerts.Details.fastFlux description: Fast flux. type: Unknown - contextPath: NSM.Alerts.Details.triggeredComponentAttacks description: Triggered component attack. type: Unknown - contextPath: NSM.Alerts.Details.sqlInjection description: SQL injection. type: Unknown - contextPath: NSM.Alerts.Details.callbackDetectors description: Callback detectors. type: Unknown - contextPath: NSM.Alerts.Details.exceededThreshold description: Exceeded threshold. type: Unknown - contextPath: NSM.Alerts.Details.communicationRuleMatch description: Communication rule match. type: Unknown - contextPath: NSM.Alerts.Description description: Description. type: String - contextPath: NSM.Alerts.Description.btp description: Benign Trigger Probability (BTP). type: String - contextPath: NSM.Alerts.Description.rfSB description: Recommended For Smart Blocking (RFSB). type: String - contextPath: NSM.Alerts.Description.protectionCategory description: Protection category. type: String - contextPath: NSM.Alerts.Description.target description: The target. type: String - contextPath: NSM.Alerts.Description.httpResponseAttack description: HTTP response attack. type: String - contextPath: NSM.Alerts.Description.priority description: Priority. type: String - contextPath: NSM.Alerts.Protocols description: Protocols. type: String - contextPath: NSM.Alerts.Attack.attackCategory description: Attack category. type: String - contextPath: NSM.Alerts.Attack.attackSubCategory description: Attack sub-category. type: String - contextPath: NSM.Alerts.Description.snortEngine description: Snort engine. type: String - contextPath: NSM.Alerts.Description.versionAdded description: The date the version was added. type: String - contextPath: NSM.Alerts.Description.versionUpdated description: The date the version was updated. type: Unknown - contextPath: NSM.Alerts.Attack.nspId description: Network Security Platform (NSP) ID. type: String - contextPath: NSM.Alerts.Description.reference.cveId description: Common Vulnerabilities and Exposures (CVE) ID. type: String - contextPath: NSM.Alerts.Description.reference.microsoftId description: Microsoft ID. type: String - contextPath: NSM.Alerts.Description.reference.bugtraqId description: Bugtraq ID. type: String - contextPath: NSM.Alerts.Description.reference.certId description: Cert ID. type: Unknown - contextPath: NSM.Alerts.Description.reference.arachNidsId description: Arachnics ID. type: String - contextPath: NSM.Alerts.Description.reference.additionInfo description: Additional information. type: String - contextPath: NSM.Alerts.Description.comments.comments description: Comments. type: String - contextPath: NSM.Alerts.Description.comments.availabeToChildDomains description: Whether the alert is available to child domains. type: Boolean - contextPath: NSM.Alerts.Description.comments.parentDomainComments description: Parent domain comments. type: Unknown - name: nsm-get-attacks description: If an attack is given, the command returns the details for the specific attack. Otherwise, gets all available attack definitions in the Manager UI. This command can take a few minutes. If you get a timeout error, increase the timeout by using the parameter "execution-timeout". arguments: - name: attack_id description: The ID of the attack. To get the attack_id, use the !nsm-get-attacks command, without an attack ID. outputs: - contextPath: InfoFile.Name description: File name. type: string - contextPath: InfoFile.EntryID description: The entry ID of the report. type: string - contextPath: InfoFile.Size description: File size. type: number - contextPath: InfoFile.Type description: File type, e.g., "PE". type: string - contextPath: InfoFile.Info description: Basic information about the file. type: string - contextPath: NSM.Attacks.Direction description: Attack direction. type: Unknown - contextPath: NSM.Attacks.Severity description: Attack severity. type: Number - contextPath: NSM.Attacks.ID description: Attack ID. type: String - contextPath: NSM.Attacks.Name description: Attack name. type: String - contextPath: NSM.Attacks.Category description: Attack category. type: String - contextPath: NSM.Attacks.description.definition description: Attack Definition. type: String - contextPath: NSM.Attacks.description.btp description: Benign Trigger Probability (BTP). type: String - contextPath: NSM.Attacks.description.rfSB description: Recommended For Smart Blocking (RFSB). type: String - contextPath: NSM.Attacks.description.protectionCategory description: Protection category. type: String - contextPath: NSM.Attacks.description.target description: Attack target. type: String - contextPath: NSM.Attacks.description.httpResponseAttack description: HTTP Response Attack. type: String - contextPath: NSM.Attacks.description.priority description: Attack priority. type: String - contextPath: NSM.Attacks.description.protocols description: Attack protocols. type: String - contextPath: NSM.Attacks.description.attackCategory description: Attack category. type: String - contextPath: NSM.Attacks.description.attackSubCategory description: Attack sub-category. type: String - contextPath: NSM.Attacks.description.snortEngine description: Attack snort engine. type: String - contextPath: NSM.Attacks.description.versionAdded description: The date the attack version was added. type: String - contextPath: NSM.Attacks.description.versionUpdated description: The date the attack version was updated. type: String - contextPath: NSM.Attacks.description.reference.nspId description: Attack Network Security Platform (NSP) ID. type: String - contextPath: NSM.Attacks.description.reference.cveId description: Attack Common Vulnerabilities and Exposures (CVE) ID. type: String - contextPath: NSM.Attacks.description.reference.microsoftId description: Attack Microsoft ID. type: String - contextPath: NSM.Attacks.description.reference.bugtraqId description: Attack bugtraq ID. type: String - contextPath: NSM.Attacks.description.reference.certId description: Attack cert ID. type: String - contextPath: NSM.Attacks.description.reference.arachNidsId description: Arachnids ID. type: String - contextPath: NSM.Attacks.description.reference.additionInfo description: Additional information. type: Unknown - contextPath: NSM.Attacks.description.comments.comments description: Comments. type: String - contextPath: NSM.Attacks.description.comments.availabeToChildDomains description: Whether the attack is available to child domains. type: Boolean - contextPath: NSM.Attacks.description.comments.parentDomainComments description: Parent domain comments. type: Unknown - name: nsm-get-domains description: If a domain ID is given, the command returns the details of the specific domain. Otherwise, gets all available domains. arguments: - name: domain_id description: Specific domain ID. Leave blank for all domains. To get the domain_id use !nsm-get-domains command and leave the parameter blank. - name: limit description: The maximum number of records to return. defaultValue: 50. - name: page description: The specific result page to display. - name: page_size description: The number of records in a page. outputs: - contextPath: NSM.Domains.ID description: Domain ID. type: Number - contextPath: NSM.Domains.Name description: Domain name. type: String - contextPath: NSM.Domains.childdomains description: The children of the domain. type: Unknown - name: nsm-get-sensors description: Gets the list of sensors available in the specified domain. If the domain is not specified, details of all the sensors in all ADs will be provided. arguments: - name: domain_id description: Specific domain ID. Leave blank for all domains. To get the domain_id use !nsm-get-domains command and leave the parameter blank. - name: limit description: The maximum number of records to return. defaultValue: 50 - name: page description: The specific result page to display. - name: page_size description: The number of records in a page. outputs: - contextPath: NSM.Sensors.ID description: Sensor ID. type: Number - contextPath: NSM.Sensors.Name description: Name of the sensor. type: String - contextPath: NSM.Sensors.model description: Sensor model. type: String - contextPath: NSM.Sensors.Description description: Sensor description. type: String - contextPath: NSM.Sensors.DomainID description: ID of the domain to which this sensor belongs. type: Number - contextPath: NSM.Sensors.isFailOver description: Whether the sensor is failover. type: Boolean - contextPath: NSM.Sensors.isNTBA description: Whether there is Network Threat Behavior Analysis (NTBA). type: Boolean - contextPath: NSM.Sensors.isLoadBalancer description: Whether the sensor is a load balancer. type: Boolean - contextPath: NSM.Sensors.SerialNumber description: The sensor serial number. type: Unknown - contextPath: NSM.Sensors.SigsetVersion description: Signature set version number applied to the sensor. type: String - contextPath: NSM.Sensors.DATVersion description: DAT version of the sensor. type: String - contextPath: NSM.Sensors.SoftwareVersion description: Sensor software version. type: String - contextPath: NSM.Sensors.LastSignatureUpdateTs description: Last configuration download timestamp. type: Date - contextPath: NSM.Sensors.IPSPolicyID description: Intrusion prevent system (IPS) policy ID applied to the sensor. type: Number - contextPath: NSM.Sensors.ReconPolicyID description: Recon policy ID applied to the sensor. type: Number - contextPath: NSM.Sensors.LastModTs description: Last modified timestamp. type: Unknown - contextPath: NSM.Sensors.IP Address description: Sensor IP address. type: String - contextPath: NSM.Sensors.nsmVersion description: Network Security Manager (NSM) version. type: String - contextPath: NSM.Sensors.MemberSensors description: Sensors members. type: Unknown - name: nsm-get-ips-policies description: Gets all the IPS policies defined in the specific domain. arguments: - name: domain_id description: Specific domain ID. To get the domain_id use !nsm-get-domains command and leave the parameter blank. required: true - name: limit description: The maximum number of records to return. defaultValue: 50 - name: page description: The specific result page to display. - name: page_size description: The number of records in a page. outputs: - contextPath: NSM.IPSPolicies.IsEditable description: Whether the IPS policy is editable. type: Boolean - contextPath: NSM.IPSPolicies.DomainID description: ID of the domain to which this policy belongs. type: Number - contextPath: NSM.IPSPolicies.VisibleToChildren description: Policy visible to child domain. type: Boolean - contextPath: NSM.IPSPolicies.ID description: IPS policy ID. type: Number - contextPath: NSM.IPSPolicies.Name description: IPS policy name. type: String - name: nsm-get-ips-policy-details description: Gets all the IPS policies defined in the specific domain. arguments: - name: policy_id description: Specific IPS policy ID. To get the policy_id use !nsm-get-ips-policies command. required: true outputs: - contextPath: NSM.IPSPolicies.ID description: IPS policy ID. type: number - contextPath: NSM.IPSPolicies.Name description: IPS policy name. type: string - contextPath: NSM.IPSPolicies.Description description: IPS policy information. type: string - contextPath: NSM.IPSPolicies.CreatedTime description: Policy creation time. type: string - contextPath: NSM.IPSPolicies.IsEditable description: Whether the IPS policy is editable. type: boolean - contextPath: NSM.IPSPolicies.VisibleToChildren description: Whether the IPS Policy is visible to the domain's children. type: boolean - contextPath: NSM.IPSPolicies.Version description: IPS policy version. type: number - contextPath: NSM.IPSPolicies.InboundRuleSet description: Inbound rule set. type: string - contextPath: NSM.IPSPolicies.OutboundRuleSet description: Outbound rule set. type: string - contextPath: NSM.IPSPolicies.ExploitAttacks description: A list of exploit attacks related to the IPS policy. type: Unknown - name: nsm-update-alerts description: Update state or assignee of alerts. It is required to provide at least one of them. If none of the alerts match the time_period they won't be updated. arguments: - name: state auto: PREDEFINED predefined: - ANY - Acknowledged - Unacknowledged description: Alert state. defaultValue: ANY - name: time_period auto: PREDEFINED predefined: - LAST_5_MINUTES - LAST_1_HOUR - LAST_6_HOURS - LAST_12_HOURS - LAST_24_HOURS - LAST_7_DAYS - LAST_14_DAYS - CUSTOM description: Time period. defaultValue: LAST_7_DAYS - name: start_time description: Start time in "mm/dd/yyyy HH:MM" format. Used for custom time only. - name: end_time description: End time in "mm/dd/yyyy HH:MM" format. Used for custom time only. - name: new_state auto: PREDEFINED predefined: - Acknowledged - Unacknowledged description: The new alert state. - name: new_assignee description: The new assignee. - name: search description: Search string in alert details. - name: filter description: 'Filter alert by fields. example: "name:hello;direction:Inbound,Outbound;attackcount:>3,<4". To use the "name" field in the filter, enter only one name in each command run. Filter on the following columns is allowed - name, assignTo, application, layer7Data, result, attackCount, relevance, alertId, direction, device, domain, interface, attackSeverity, nspId, btp, attackCategory, malwarefileName, malwarefileHash, malwareName, malwareConfidence, malwareEngine ,executableName, executableHash, executableConfidenceName, attackerIPAddress, attackerPort, attackerRisk, attackerProxyIP, attackerHostname, targetIPAddress, targetPort, targetRisk, targetProxyIP, targetHostname, botnetFamily.' outputs: - contextPath: NSM.Alerts.ID description: Alert ID. type: number - contextPath: NSM.Alerts.Name description: Alert name. type: String - contextPath: NSM.Alerts.uniqueAlertId description: Unique alert ID. type: String - contextPath: NSM.Alerts.State description: Alert state (Acknowledged,Unacknowledged). type: String - contextPath: NSM.Alerts.Assignee description: Alert assignee. type: String - contextPath: NSM.Alerts.CreatedTime description: Alert creation time. type: String - contextPath: NSM.Alerts.AttackSeverity description: Alert severity. type: String - contextPath: NSM.Alerts.Event.time description: The creation time of the event that triggered the alert. type: Date - contextPath: NSM.Alerts.Event.direction description: The direction of the event (Outbound, Inbound). type: String - contextPath: NSM.Alerts.Event.result description: The result of the event. type: String - contextPath: NSM.Alerts.Event.attackCount description: Attack count. type: Number - contextPath: NSM.Alerts.Event.relevance description: The event relevance. type: String - contextPath: NSM.Alerts.Event.alertId description: Alert ID. type: String - contextPath: NSM.Alerts.Event.domain description: The domain. type: String - contextPath: NSM.Alerts.Event.interface description: The event's interface. type: String - contextPath: NSM.Alerts.Event.device description: The relevant device. type: String - contextPath: NSM.Alerts.Attack.nspId description: Network Security Platform (NSP) ID. type: String - contextPath: NSM.Alerts.Attack.btp description: Benign Trigger Probability (BTP). type: String - contextPath: NSM.Alerts.Attack.attackCategory description: The attack category. type: String - contextPath: NSM.Alerts.Attacker.ipAddrs description: The attacker IP address. type: String - contextPath: NSM.Alerts.Attacker.port description: The port. type: Number - contextPath: NSM.Alerts.Attacker.hostName description: The attacker host name. type: String - contextPath: NSM.Alerts.Attacker.country description: The attacker country. type: String - contextPath: NSM.Alerts.Attacker.os description: The attacker operating system. type: Unknown - contextPath: NSM.Alerts.Attacker.vmName description: The attacker VM name. type: Unknown - contextPath: NSM.Alerts.Attacker.proxyIP description: The attacker proxy IP. type: String - contextPath: NSM.Alerts.Attacker.user description: The user. type: Unknown - contextPath: NSM.Alerts.Attacker.risk description: Attacker risk. type: String - contextPath: NSM.Alerts.Attacker.networkObject description: The attacker network object. type: Unknown - contextPath: NSM.Alerts.Target.ipAddrs description: The target IP address. type: String - contextPath: NSM.Alerts.Target.port description: The target port. type: Number - contextPath: NSM.Alerts.Target.hostName description: The target host name. type: String - contextPath: NSM.Alerts.Target.country description: The target country. type: String - contextPath: NSM.Alerts.Target.os description: The target operating system. type: Unknown - contextPath: NSM.Alerts.Target.vmName description: The target VM name. type: Unknown - contextPath: NSM.Alerts.Target.proxyIP description: The target proxy IP. type: String - contextPath: NSM.Alerts.Target.user description: The target user. type: Unknown - contextPath: NSM.Alerts.Target.risk description: The target risk. type: String - contextPath: NSM.Alerts.Target.networkObject description: The target network object. type: Unknown - contextPath: NSM.Alerts.MalwareFile.fileName description: The name of the malware file. type: String - contextPath: NSM.Alerts.MalwareFile.fileHash description: The file hash of the malware file. type: String - contextPath: NSM.Alerts.MalwareFile.fileSHA1Hash description: The malware file SHA1 hash. type: String - contextPath: NSM.Alerts.MalwareFile.fileSHA256Hash description: The file SHA256 hash of the malware file. type: Unknown - contextPath: NSM.Alerts.MalwareFile.malwareName description: The name of the malware. type: String - contextPath: NSM.Alerts.MalwareFile.malwareConfidence description: Malware confidence. type: String - contextPath: NSM.Alerts.MalwareFile.engine description: Malware file engine. type: String - contextPath: NSM.Alerts.MalwareFile.engineId description: Malware file engine ID. type: Number - contextPath: NSM.Alerts.MalwareFile.size description: The Malware file size. type: Unknown - contextPath: NSM.Alerts.MalwareFile.description description: Malware file description. type: Unknown - contextPath: NSM.Alerts.MalwareFile.additionalReference description: Malware file additional reference. type: Unknown - contextPath: NSM.Alerts.MalwareFile.cveId description: Malware File CVE ID. type: Unknown - contextPath: NSM.Alerts.endpointExcutable.name description: Endpoint executable name. type: String - contextPath: NSM.Alerts.endpointExcutable.hash description: Endpoint executable hash. type: String - contextPath: NSM.Alerts.endpointExcutable.malwareConfidence description: Endpoint executable malware confidence. type: String - contextPath: NSM.Alerts.detection.managerId description: Manager ID. type: Number - contextPath: NSM.Alerts.detection.manager description: The detection manager. type: Unknown - contextPath: NSM.Alerts.detection.domain description: Detection domain. type: String - contextPath: NSM.Alerts.detection.device description: Detection device. type: String - contextPath: NSM.Alerts.detection.deviceId description: Detection device ID. type: String - contextPath: NSM.Alerts.detection.interface description: Detection interface. type: String - contextPath: NSM.Alerts.Application description: The application associated with the alert. type: String - contextPath: NSM.Alerts.layer7Data description: Layer 7 information. type: String - contextPath: NSM.Alerts.EventResult description: Event result. type: String - contextPath: NSM.Alerts.SensorID description: Sensor ID. type: String - name: nsm-list-pcap-file description: Retrieves the list of captured PCAP files. arguments: - name: sensor_id required: true description: The ID of the sensor. To get the sensor_id, use the !nsm-get-sensors command. - name: limit description: The maximum number of records to return. defaultValue: 50 - name: page description: The specific result page to display. The default is 1. - name: page_size description: The number of records in a page. outputs: - contextPath: NSM.PcapFile description: PCAP file name. type: string - name: nsm-export-pcap-file description: Exports the captured PCAP file. arguments: - name: sensor_id required: true description: The ID of the sensor. To get the sensor_id, use the command !nsm-get-sensors. - name: file_name required: true description: The name of the wanted file. To get the file_name, use the command !nsm-list-pcap-file. outputs: - contextPath: InfoFile.Name description: File name. type: string - contextPath: InfoFile.EntryID description: The entry ID of the report. type: string - contextPath: InfoFile.Size description: File size. type: number - contextPath: InfoFile.Type description: File type, e.g., "PE". type: string - contextPath: InfoFile.Info description: Basic information about the file. type: string - name: nsm-list-domain-device description: List the devices related to a given domain. arguments: - name: domain_id description: The ID of the domain. To get the domain_id, use the !nsm-get-domains command. required: true - name: limit description: The maximum number of devices to return. - name: all_results description: Return all devices related to the given domain. auto: PREDEFINED predefined: - yes - no outputs: - contextPath: NSM.Device.ContactInformation description: The contact information of the device. type: string - contextPath: NSM.Device.DeviceId description: The id of the device. type: number - contextPath: NSM.Device.DeviceName description: The name of the device. type: string - contextPath: NSM.Device.DeviceType description: The type of the device. type: string - contextPath: NSM.Device.Location description: The location of the device. type: string - contextPath: NSM.Device.UpdatingMode description: The updating mode of the device. type: string - name: nsm-list-device-interface description: List the interfaces related to a given device. arguments: - name: domain_id description: The ID of the domain. To get the domain_id, use the !nsm-get-domains command. required: true - name: device_id required: true description: The ID of the device. To get the device ID, use the !nsm-list-domain-device command. - name: limit description: The maximum number of interfaces to return. - name: all_results description: Return all interfaces related to the given device. auto: PREDEFINED predefined: - yes - no outputs: - contextPath: NSM.Interface.InterfaceId description: The id of the interface. type: number - contextPath: NSM.Interface.InterfaceName description: The name of the interface. type: Unknown - contextPath: NSM.Interface.InterfaceType description: The type of the interface. type: string - name: nsm-assign-device-policy description: Assign a policy to a specific device. arguments: - name: domain_id description: The ID of the domain. To get the domain_id, use the !nsm-get-domains command. required: true - name: device_id required: true description: The ID of the device. To get the device ID, use the !nsm-list-domain-device command. - name: pre_firewall_policy_name description: The name of the policy to add to the top of the rule order and evaluated first. To get the policies, use the !nsm-list-domain-firewall-policy command. - name: post_firewall_policy_name description: The name of the policy to add to the end of the rule order and evaluated last. To get the policies, use the !nsm-list-domain-firewall-policy command. - name: nsm-list-device-policy description: List all the policies assigned to a domain or a specific device. arguments: - name: domain_id description: The ID of the domain. To get the domain_id, use the !nsm-get-domains command. required: true - name: device_id description: The ID of the device. To get the device ID, use the !nsm-list-domain-device command. - name: limit description: The maximum number of policies to return. - name: all_results description: Return all policies assigned to a domain or a specific device. auto: PREDEFINED predefined: - yes - no outputs: - contextPath: NSM.DevicePolicy.DeviceName description: The name of the device. type: string - contextPath: NSM.DevicePolicy.AtdUserForInboundATDAnalysis description: "" type: Unknown - contextPath: NSM.DevicePolicy.InterfaceName description: The name of the interface. type: string - contextPath: NSM.DevicePolicy.FirewallPolicyLast description: "" type: Unknown - contextPath: NSM.DevicePolicy.ReconnaissancePolicy description: "" type: Unknown - contextPath: NSM.DevicePolicy.PolicyGroup description: "" type: Unknown - contextPath: NSM.DevicePolicy.AtdUserForOutboundATDAnalysis description: "" type: Unknown - contextPath: NSM.DevicePolicy.DeviceId description: The id of the device. type: number - contextPath: NSM.DevicePolicy.AdvancedMalwareOutboundPolicy description: "" type: Unknown - contextPath: NSM.DevicePolicy.QosInboundPolicy description: "" type: Unknown - contextPath: NSM.DevicePolicy.ConnectionLimitingPolicy description: "" type: Unknown - contextPath: NSM.DevicePolicy.QosOutboundPolicy description: "" type: Unknown - contextPath: NSM.DevicePolicy.ProtectionOptionsPolicy description: "" type: Unknown - contextPath: NSM.DevicePolicy.AdvancedMalwareInboundPolicy description: "" type: Unknown - contextPath: NSM.DevicePolicy.QosOutboundRateLimitingProfile description: "" type: Unknown - contextPath: NSM.DevicePolicy.IpsPolicy description: "" type: Unknown - contextPath: NSM.DevicePolicy.QosInboundRateLimitingProfile description: "" type: Unknown - contextPath: NSM.DevicePolicy.FirewallPolicyFirst description: "" type: Unknown - name: nsm-assign-interface-policy description: Assign a policy to a specific interface. arguments: - name: domain_id description: The ID of the domain. To get the domain_id, use the !nsm-get-domains command. required: true - name: interface_id required: true description: The ID of the interface. To get the interface ID, use the !nsm-list-device-interface command. - name: firewall_policy_name description: The name of the firewall policy that will be connected to the interface. To get the policy name, use the !nsm-list-domain-firewall-policy command. - name: firewall_port_policy_name description: The name of the firewall policy that will be connected to the interface/port. To get the policy name, use the !nsm-list-domain-firewall-policy command. - name: ips_policy_name description: The name of the IPS policy that will be connected to the interface. To get the policy name, use the !nsm-get-ips-policies command. - name: custom_policy_json description: A Json with firewall policy types as keys and firewall policy names as values. (e.g `{"advancedMalwareInboundPolicy":"test"}`). To see all the firewall policy options visit this page https://docs.trellix.com/bundle/network-security-platform-9.1.x-manager-api-reference-guide/page/GUID-5E5F9514-935F-4F16-B2F0-C48E465A4E7C.html. - name: nsm-list-interface-policy description: List all the policies assigned to all interfaces or a specific interface. arguments: - name: domain_id description: The ID of the domain. To get the domain_id, use the !nsm-get-domains command. required: true - name: interface_id description: The ID of the interface. To get the interface ID, use the !nsm-list-device-interface command. - name: limit description: The maximum number of policies to return. - name: all_results description: Return all policies assigned to all interfaces or a specific interface. auto: PREDEFINED predefined: - yes - no outputs: - contextPath: NSM.InterfacePolicy.DeviceName description: The name of the device. type: string - contextPath: NSM.InterfacePolicy.AtdUserForInboundATDAnalysis description: "" type: Unknown - contextPath: NSM.InterfacePolicy.InterfaceName description: The name of the interface. type: string - contextPath: NSM.InterfacePolicy.FirewallPolicyLast description: "" type: Unknown - contextPath: NSM.InterfacePolicy.ReconnaissancePolicy description: "" type: Unknown - contextPath: NSM.InterfacePolicy.PolicyGroup description: "" type: Unknown - contextPath: NSM.InterfacePolicy.AtdUserForOutboundATDAnalysis description: "" type: Unknown - contextPath: NSM.InterfacePolicy.DeviceId description: The id of the device. type: number - contextPath: NSM.InterfacePolicy.AdvancedMalwareOutboundPolicy description: "" type: Unknown - contextPath: NSM.InterfacePolicy.QosInboundPolicy description: "" type: Unknown - contextPath: NSM.InterfacePolicy.ConnectionLimitingPolicy description: "" type: Unknown - contextPath: NSM.InterfacePolicy.QosOutboundPolicy description: "" type: Unknown - contextPath: NSM.InterfacePolicy.ProtectionOptionsPolicy description: "" type: Unknown - contextPath: NSM.InterfacePolicy.AdvancedMalwareInboundPolicy description: "" type: Unknown - contextPath: NSM.InterfacePolicy.QosOutboundRateLimitingProfile description: "" type: Unknown - contextPath: NSM.InterfacePolicy.IpsPolicy description: "" type: Unknown - contextPath: NSM.InterfacePolicy.QosInboundRateLimitingProfile description: "" type: Unknown - contextPath: NSM.InterfacePolicy.FirewallPolicyFirst description: "" type: Unknown - name: nsm-get-device-configuration description: Provides configuration information of a given device. arguments: - name: device_id description: The ID of the device. To get the device ID, use the !nsm-get-sensors command. required: true outputs: - contextPath: NSM.DeviceConfiguration.IsSSLConfigurationChanged description: Was the ssl configuration changed. type: boolean - contextPath: NSM.DeviceConfiguration.DeviceName description: The name of the device. type: string - contextPath: NSM.DeviceConfiguration.IsConfigurationChanged description: Was the configuration changed. type: boolean - contextPath: NSM.DeviceConfiguration.IsMalwareConfigurationChanged description: "" type: boolean - contextPath: NSM.DeviceConfiguration.LastUpdateTime description: "" type: Unknown - contextPath: NSM.DeviceConfiguration.IsGAMUpdateRequired description: "" type: boolean - contextPath: NSM.DeviceConfiguration.IsSignatureSetConfigurationChanged description: "" type: Unknown - contextPath: NSM.DeviceConfiguration.IsSigsetConfigPushRequired description: "" type: boolean - contextPath: NSM.DeviceConfiguration.IsBotnetPushRequired description: "" type: boolean - contextPath: NSM.DeviceConfiguration.IsPolicyConfigurationChanged description: "" type: boolean - contextPath: NSM.DeviceConfiguration.IsSSLPushRequired description: "" type: boolean - contextPath: NSM.DeviceConfiguration.IsGloablPolicyConfigurationChanged description: "" type: boolean - contextPath: NSM.DeviceConfiguration.IsBotnetConfigurationChanged description: "" type: boolean - name: nsm-deploy-device-configuration polling: true description: "Deploy the pending changes.\n Note: In order to avoid extra run time, it is recommended to deploy only the changes that are pending.\nTo get the pending changes, use the !nsm-get-device-configuration command." arguments: - name: request_id description: This is for the polling to work. not for the user. hidden: true - name: device_id description: The ID of the device. To get the device ID, use the !nsm-get-sensors command. required: true - name: push_ssl_key description: Deploy the SSL configuration pending changes. auto: PREDEFINED predefined: - "true" - "false" - name: push_gam_updates description: Deploy the Gateway Anti-Malware configuration pending changes. auto: PREDEFINED predefined: - "true" - "false" - name: push_configuration_signature_set description: Deploy the Signature set configuration pending changes. auto: PREDEFINED predefined: - "true" - "false" - name: push_botnet description: Deploy the Firewall policy description pending changes. auto: PREDEFINED predefined: - "true" - "false" - name: interval_in_seconds description: The interval between status checks. runonce: false script: '-' type: python subtype: python3 dockerimage: demisto/python3:3.12.13.10116658 fromversion: 6.5.0 tests: - Test_McAfeeNSMv2_using_v9 - Test_McAfeeNSMv2_using_v10 sectionorder: - Connect - Collect