APIRef_tm_cli_alias_private¶
mgmt/tm/cli/alias/private
Manage user private command aliases
REST Endpoints
- Collection URI
/mgmt/tm/cli/alias/private
- Collection Methods
OPTIONS, GET
- Resource URI
/mgmt/tm/cli/alias/private/~resource id
- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
- Resource Natural Key
name, partition
Properties
Name | Type | Default Value | Required | Access | Description |
---|---|---|---|---|---|
tmCommand |
string | required | read/write | The command that is run when the alias is entered. If the command is more than one word it must be enclosed in quotes. | |
description |
string | optional | read/write | If “cli preference show-aliases” is enabled the description will be displayed in context sensitive help. | |
tmPartition |
string | Common | optional | read/write | |
user |
string | optional | read/write |
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.