Skip to main content
ONTAP 9.16.1 commands

security login role show-ontapi

Contributors
Suggest changes

Display the mapping between Data ONTAP APIs and CLI commands

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The security login role show-ontapi command displays ONTAP APIs (ONTAPIs) and the CLI commands that they are mapped to.

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all fields.

[-ontapi <text>] - ONTAPI Name

Use this parameter to view the corresponding CLI command for the specified API.

[-command <text>] - CLI Command

Use this parameter to view the corresponding API or APIs for the specified CLI command.

Examples

The following command displays all ONTAP APIs and their mapped CLI commands:

cluster1::> security login role show-ontapi
ONTAPI                      Command
--------------------------- ---------------------------------------------------
aggr-add                    storage aggregate add-disks
aggr-check-spare-low        storage aggregate check_spare_low
aggr-create                 storage aggregate create
aggr-destroy                storage aggregate delete
aggr-get-filer-info         aggr
aggr-get-iter               storage aggregate show-view
aggr-offline                storage aggregate offline
aggr-online                 storage aggregate online
aggr-options-list-info      storage aggregate show
aggr-rename                 storage aggregate rename
aggr-restrict               storage aggregate restrict
aggr-set-option             storage aggregate modify
autosupport-budget-get      system node autosupport budget show
autosupport-budget-get-iter system node autosupport budget show
autosupport-budget-get-total-records
                            system node autosupport budget show
autosupport-budget-modify   system node autosupport budget modify
autosupport-config-get      system node autosupport show
autosupport-config-get-iter system node autosupport show
autosupport-config-get-total-records
                            system node autosupport show
autosupport-config-modify   system node autosupport modify
Press <space> to page down, <return> for next line, or 'q' to quit...

The following example displays all ONTAP APIs which are mapped to the specified CLI command:

cluster1::> security login role show-ontapi -command version
ONTAPI                      Command
--------------------------- ---------------------------------------------------
system-get-ontapi-version   version
system-get-version          version
2 entries were displayed.

The following example displays the CLI command that is mapped to the specified Data ONTAPI API:

cluster1::> security login role show-ontapi -ontapi aggr-create

ONTAPI Name: aggr-create
    Command: storage aggregate create