R80 Management API tips and tricks - "show-objects" command

Document created by Robert Decker Employee on Jul 3, 2018Last modified by Robert Decker Employee on Jul 3, 2018
Version 2Show Document
  • View in full screen mode

The show-objects API command is very useful for general objects search, by specifying the objects "type" parameter and filtering the results by "filter" parameter.

 

Here is a list of available object types (R80.10) that can be used:

access-role
address-range
administrator
application-site
application-site-category
application-site-group
data-center
data-center-object
dns-domain
dynamic-object
gateways-and-servers
group
group-with-exclusion
host
host-ckp
mds
multicast-address-range
network
opsec-application
scada-application
security-zone
service-dce-rpc
service-icmp
service-icmp6
service-other
service-rcp
service-sctp
service-tcp
service-udp
service-group
session
simple-gateway
tag
task
time
time-group
vpn-community-meshed
vpn-community-star
unused-object

 

The "filter" parameter can be made up as an expression, containing logical operators -  'AND', 'OR', in capital letters. The provided expression should be exactly the same as it would be given in SmartConsole GUI.

 

For example, to search all tcp services with names containing "aol" or "bgp", use - 

show-objects type service-tcp filter "aol OR bgp"

 

To search all tcp services having a name containing both "edonkey" and "466", use - 

show-objects type service-tcp filter "edonkey AND 466"

 

In addition, there are undocumented parameters "in" and "not in", for string matching in textual fields, such as name and comments.

 

For example, to search all tcp services containing "ext" in the name field, use - 

show-objects type service-tcp in.1 name in.2 ext

 

To search all tcp services containing "cifs" in the comments field, use - 

show-objects type service-tcp in.1 comments in.2 cifs

 

To search all tcp services NOT containing "cifs" in the comments field, use - 

show-objects type service-tcp not.in.1 comments not.in.2 cifs

 

Hope this helps.

Robert.

8 people found this helpful

Attachments

    Outcomes