Applies To:
Show Versions
3-DNS Controller versions 1.x - 4.x
- 4.2 PTF-10, 4.2 PTF-09, 4.2 PTF-08, 4.2 PTF-07, 4.2 PTF-06, 4.2 PTF-05, 4.2 PTF-04, 4.2 PTF-03, 4.2 PTF-02, 4.2 PTF-01, 4.2.0
B
3dpipe Command Reference
3dpipe commands
The 3dpipe utility is a command line utility that you can use to view summary information, and to enable and disable several objects in the 3-DNS configuration. This chapter lists the various 3dpipe commands and their syntax requirements. Table B.1 outlines the conventions used in the command line syntax.
Table B.2 provides a concise listing of the individual 3dpipe commands, along with the page reference where you can find a detailed description of the command syntax and usage.
datacenter (or dc)
3dpipe datacenter show all
3dpipe dc <datacenter_name> status
3dpipe dc <datacenter_name> disable [<time in seconds> [<by_whom>]]
3dpipe dc <datacenter_name> enable
With the datacenter command, you can perform the following tasks:
- View all the configured data centers
- View whether a specific data center is enabled or disabled (the status)
- Disable a specific data center for a certain period of time
- Enable a data center that is disabled
-help (or -h)
3dpipe [-h | -help]
The -help or -h flag displays the 3dpipe command syntax or usage text for all available commands.
Note: To display detailed online help for the 3dpipe command, type: man 3dpipe.
<server type>
3dpipe <3dns | bigip | edgefx | edge_fx | globalsite | gsite | host> show all
3dpipe <3dns | bigip | edgefx | edge_fx | globalsite | gsite | host> <ip_address> status
3dpipe <3dns | bigip | edgefx | edge_fx | globalsite | gsite | host> <ip_address> [disable <time in seconds> [<by_whom>]]
3dpipe <3dns | bigip | edgefx | edge_fx | globalsite | gsite | host> <ip_address> enable
3dpipe <bigip | edgefx | edge_fx | host> <ip_address> virtual show all
With the <server type> command, you can perform the following tasks:
- View all the servers of the specified type
- View whether a specific server is enabled or disabled (the status)
- Disable a specific server for a certain period of time
- Enable a server that is disabled
- View the virtual servers for a specific server
stats
3dpipe stats summary
With the stats command, you can view a summary of the real-time statistics for the 3-DNS.
syncgroup (or sg)
3dpipe syncgroup [<syncgroup_name>] show servers
3dpipe sg [<syncgroup_name>] status
3dpipe sg [<syncgroup_name>] disable [<time in seconds> [<by_whom>]]
3dpipe sg [<syncgroup_name>] enable
With the syncgroup command, you can perform the following tasks:
- View all the members in a sync group
- View whether a specific sync group is enabled or disabled (the status)
- Disable a specific sync group for a certain period of time
- Enable a sync group that is disabled
-version (or -v)
3dpipe <-version | -v>
The version command displays the current version of the iControl portal that is used by the 3dpipe utility.
virtual (or vs)
3dpipe virtual <ipaddress>:<port> status
3dpipe vs <ipaddress>:<port> disable [<time in seconds> [<by_whom>]]
3dpipe vs <ipaddress>:<port> enable
With the virtual command, you can perform the following tasks:
- View whether a specific virtual server is enabled or disabled (the status)
- Disable a specific virtual server for a certain period of time
- Enable a virtual server that is disabled
wideip (or wip)
3dpipe wideip show all
3dpipe wip <wideip_name> status
3dpipe wip <wideip_name> disable [<time in seconds> [<by_whom>]]
3dpipe wip <wideip_name> enable
3dpipe wip <wideip_name> pool show all
3dpipe wip <wideip_name> pool <pool_name> status
3dpipe wip <wideip_name> pool <pool_name> disable [<time in seconds> [<by_whom>]]
3dpipe wip <wideip_name> pool <pool_name> enable
3dpipe wideip <wide_IP_name> pool <pool_name> virtual show all
3dpipe wideip <wide_IP_name> dc <datacenter_name> disable [<time in seconds> [<by_whom>]]
3dpipe wideip <wide_IP_name> dc <datacenter_name> enable
3dpipe wideip <wide_IP_name> dc <datacenter_name> status
With the wideip command, you can perform the following tasks:
- View all wide IPs
- View whether a specific wide IP is enabled or disabled (the status)
- Disable a specific wide IP for a certain period of time
- Enable a wide IP that is disabled
- View all of the pools for a specific wide IP
- View whether a specific pool is enabled or disabled (the status)
- Disable a specific pool for a certain period of time
- Enable a pool that is disabled
- Get the following information for each virtual server in a wide IP pool:
- Enabled or disabled status
- Availability status: green (available), blue (unknown), red (down), or yellow (unavailable)
- IP address
- Port
- Ratio value (for the Ratio load balancing mode)
- View the status of a wide IP, in the context of a data center
- Disable a wide IP, in the context of a data center
- Enable a wide IP, in the context of a data center