Applies To:

Show Versions Show Versions

Archived Manual Chapter: 3-DNS Reference Guide, version 4.6.2: 3dpipe Command Reference
Manual Chapter
Table of Contents   |   << Previous Chapter   |   Next Chapter >>

This article has been archived, and is no longer maintained.


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.


 

Item in text

Description

\

Continue to the next line without typing a line break.

< >

You enter text for the enclosed item. For example, if the command has <wideip_name>, type the name of the wide IP.

" "

Names that have spaces in them must be enclosed in quotation marks.

|

Separates alternate options for a command.

[ ]

Syntax inside the brackets is optional.

...

Indicates that you can type a series of items.

 

 

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.

 

Command

Description

Page

datacenter
(or dc)

Displays all data centers, and data center status.

B-3

-help (or -h)

Displays online help for 3dpipe command syntax.

B-4

<server type>

Displays all servers of the specified type, the status for servers of the specified type, and all virtual servers for servers of the specified type

B-5

stats

Displays summary statistics for the 3-DNS Controller.

B-6

syncgroup
(or sg)

Displays the sync group servers and the sync group status.

B-7

-version
(or -v)

Displays the version number for the portal.

B-8

virtual (or vs)

Displays virtual server status.

B-9

wideip
(or wip)

Displays all wide IPs, wide IP pools, wide IP status, and wide IP pool status

B-10

 

 

datacenter (or dc)

 

3dpipe datacenter show

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 | router | host> show

3dpipe <3dns | bigip | edgefx | router | host> <ip_address> status

3dpipe <3dns | bigip | edgefx | router | host> <ip_address> disable [<time in seconds> [<by_whom>]]

3dpipe <3dns | bigip | edgefx | router | host> <ip_address> enable

3dpipe <bigip | edgefx | router | host> <ip_address> virtual show

 

 

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 current statistics for the 3-DNS Controller.

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 the sync group is enabled or disabled (the status)

  • Disable the 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

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

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 wip <wideip_name> pool <pool_name> avail

3dpipe wip <wideip_name> pool <pool_name> virtual show

3dpipe wip <wideip_name> pool <pool_name> virtual <ip_address>:<port> status

3dpipe wip <wideip_name> pool <pool_name> virtual <ip_address>:<port> enable

3dpipe wip <wideip_name> pool <pool_name> virtual <ip_address>:<port> disable [<time in seconds> [<by_whom>]]

3dpipe wip <wideip_name> dc <datacenter_name> disable [<time in seconds> [<by_whom>]]

3dpipe wip <wideip_name> dc <datacenter_name> enable

3dpipe wip <wideip_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)

  • Enable a virtual server that is disabled in a wide IP pool

  • Disable a virtual server in a wide IP pool for a specified number of seconds

  • Disable a wide IP, in the context of a data center

  • Enable a wide IP that is disabled, in the context of a data center

  • View whether a specific a wide IP, in the context of a data center, is enabled or disabled (the status)



Table of Contents   |   << Previous Chapter   |   Next Chapter >>

Was this resource helpful in solving your issue?




NOTE: Please do not provide personal information.



Incorrect answer. Please try again: Please enter the words to the right: Please enter the numbers you hear:

Additional Comments (optional)