smartfolder:global : Global Smart Folder object.

Smart Folders are used to organize your core network services data. Depending on your administrative roles and business needs, you can filter your data object types, names, extensible attributes and discovered data and then place the filtered results in a Smart Folder.

The global Smart Folders are created to be shared among administrators.

Object Reference

References to smartfolder:global are object references.

The name part of the global Smart Folder object reference has the following components:

  • The name of the global Smart Folder
Example:
smartfolder:global/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:SF1

Restrictions

The object does not support the following operations:

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): comment, name.

The following fields are required to create this object:

Field Notes
name  

comment

comment

The global Smart Folder descriptive comment.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The comment is part of the base object.

group_bys

group_bys

Global Smart Folder grouping rules.

Type

A/An Smart Folder group by structure struct array.

Create

The default value is:

empty

Search

The field is not available for search.

name

name

The global Smart Folder name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

query_items

query_items

The global Smart Folder filter queries.

Type

A/An Smart Folder query item structure struct array.

Create

The default value is:

[ { 'field_type': 'NORMAL',
'name': 'type',
'op_match': True,
'operator': 'EQ',
'value': { 'value_string': 'Network/Zone/Range/Member'},
'value_type': 'ENUM'}]

Search

The field is not available for search.

Function Calls

save_as

This function is used to create a shortcut to a Global Smart Folder in a Personal Smart Folder or to create a complete copy of the Global Smart Folder and save it either as another Smart Folder or as a Global Smart Folder.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

global_flag ( Bool. ) Determines whether to save Smart Folder as Global Smart Folder. The default value is “False”.

is_shortcut ( Bool. ) Determines whether the complete copy of the Smart Folder will be created or only a shortcut. The default value is “False”.

name ( String. ) The newly created Smart Folder name. The default value is “None”.

Output fields

result ( String. ) The resulting Smart Folder object.

Fields List

Field Type Req R/O Base Search
comment String N N Y : = ~
group_bys [struct] N N N N/A
name String Y N Y : = ~
query_items [struct] N N N N/A