Skip to end of metadata
Go to start of metadata
[MANAGE-SERVER(1)       AppNexus CLI Documentation v0.486      MANAGE-SERVER(1)
NAME
       manage-server -
       list/list-dns/modify-dns/add-ip/remove-ip/reserve/modify/release/restart
       servers
SYNOPSIS
       manage-server list [-a | -r] [-s col_name | -b col_name] [-F
       perl_expression] [-f filters] [ --oc col_name ] [-R] [-v]
       manage-server list-dns [-a | -r] [-s col_name | -b col_name] [-F
       perl_expression] [-f filters] [ --oc col_name ] [-R]
       manage-server reserve -s server_id [-d description]
       manage-server modify -s server_id [-d description] [--name device_name]
       manage-server modify-dns -s server_id [--ip address] --dns dns_name
       manage-server release -s server_id [--force]
       manage-server restart -s server_id [--cycle] [--reset] [--async]
       [--force]
       manage-server add-ip -s server_id [ --ip <ip_address> | --subnet
       <subnet> ] [ --dns dns_name ] [ --force ]
       manage-server remove-ip -s server_id --ip <ip_address>
       manage-server history [-s server_id] [--depth number]
       manage-server command [--username username] [--password password]
       manage-server command -h
       manage-server (help | -h) [command]
       manage-server -V
DESCRIPTION
       This command lets you list, reserve, modify, release, and restart
       servers.
OPTIONS
       -s, --server-id
           ID number of server to reserve or release. Must be a composite
           string ’<datacenter_id>:<server_id>’, e.g. ’NYM1:1’, ’LAX1:210’.
       -a, --available
           List available servers only.
       -r, --reserved
           List reserved servers only.
       -d, --description
           Optional custom description to attach to the server.
       --dns
           The desired DNS name for the server. See the section DNS NAMES
           below for more details.
       --name
           The desired device name for the server. The device name is an
           internal name for the device which can be different from the
           hostname for baremetal machines. For dom0 servers it’s always the
           same as hostname, and it cannot be changed.
       --cycle
           Provides a power off interval of at least 1 second.
       --reset
           Performs a hard reset.
       --ip
           Specifies the IP address to be added to or removed from the
           specified server.
       --subnet
           Specifies the subnet in which to find an IP address to be added to
           the specified server.
       --depth
           Number of most recent operations to show in history. Default is 20.
       --async
           Execute command in asynchronous mode. This means that the CLI will
           not wait to apprise you of your command’s status before being
           available for the next command.
       -v, --verbose
           Output data in verbose mode (show columns for group, active,
           cpu_speed, total_memory, total_disk, xen_ver, type, ip_address, and
           lease_expires_on).
       -s, --sort
           Column name(s) for sorting (id, hostname, config, group, rack,
           state, active, cpu_speed, cores, total_memory, avail_memory,
           total_disk, avail_disk, xen_ver, type, ip_address,
           lease_expires_on, description). Use --sort
           <column_name1>{,<column_nameN>}.
       -b, --rsort
           Column name(s) for reverse sorting.
       -f, --filter
           Filter results by column name (id, hostname, config, group, rack,
           state, active, cpu_speed, cores, total_memory, avail_memory,
           total_disk, avail_disk, xen_ver, type, ip_address,
           lease_expires_on, description). Use --filter
           <column_name1>=<pattern1>{,<patternN>}
           {<column_name2>=<pattern2>{,<patternN>} where {} indicates an
           optional parameter. Do not use a space between multiple patterns.
           For example, --filter config=weba,webb.
       -F, --server-side-filter
           Filters results on the server side before they are passed to the
           client. The value for this option is a perl expression which
           controls whether rows are included in the result set returned to
           the client. Server and client side filtering can be freely
           combined. See the section SERVER SIDE FILTERING for more details.
       --oc
           Specify a comma separated list of data columns to return in list
           output.
       -R, --raw
           Output data in tab-delimited form.
       --username
           Username for API, same as for Customer Portal. Could be specified
           in CLI config file "rpc.cfg" (expected locations: /etc/appnexus,
           ~/.appnexus, or the current working directory).
       --password
           Password for API, same as for Customer Portal. If password isn’t
           specified, you’ll be asked to enter it. Note that specifying a
           password on the command line should be considered insecure.
           Password could be specified in CLI config file, but to keep the
           password safe, the file should not be accessible to anyone but
           yourself. To ensure this, set the file access mode to 400 or 600.
       -V, --version
           Version of the command-line interface you are currently using.
       -h, --help
           Display help.
COMMANDS
   list
           List either reserved or available servers. Information attached to
           each server includes id, hostname, device_name, state, activity,
           configuration, group, rack, cpu speed, cores, memory, disk, xen
           version, type, IP address, lease expiration date, and description.
           Required Parameters: none
           Optional Parameters: (-a/--available | -r/--reserved), (-s/--sort |
           -b/--rsort), -F/--server-side-filter, -f/--filter, --oc, -R/--raw,
           -v/--verbose
   list-dns
           Show list of servers with their DNS names.
           Required Parameters: none
           Optional Parameters: (-a/--available | -r/--reserved), (-s/--sort |
           -b/--rsort), -F/--server-side-filter, -f/--filter, --oc, -R/--raw
   reserve
           Reserve a server for your account. You must reserve a server before
           you can launch instances. Note that billing will begin from the
           moment a server is reserved for your account.
           Required Parameters: -s/--server-id
           Optional Parameters: -d/--description
   modify
           Change the description or device name of a server.
           Required Parameters: -s/--server-id
           Optional Parameters: -d/--description, --name
   modify-dns
           Modify the DNS name of the specified server. If multiple IP
           addresses are assigned to the server, you will need to use the --ip
           option to specify which IP address you want to modify the DNS name
           for.
           Required Parameters: -s/--server-id, --dns
           Optional Parameters: --ip
   release
           Release a previously reserved server. You must terminate all
           instances on a server before you can release it.
           Required Parameters: -s/--server-id
           Optional Parameters: none
   restart
           Reboot a reserved server.
           Required Parameters: -s/--server-id
           Optional Parameters: --cycle, --reset, --async
   add-ip
           Assigns an additional IP address to the specified server. The
           address must be on the same VLAN as the server. If the user has any
           DNS domains configured, a new A record for the new IP address will
           be added to DNS. The DNS name can be specified using the --dns
           option. If the --dns option is not used, a number will be appended
           to the part of the server hostname before the first dot, and this
           variant of the hostname will be used as the default. Please see the
           section DNS NAMES for more details.
           Required Parameters: -s/--server-id, ( --ip | --subnet )
           Optional Parameters: --dns
   remove-ip
           Removes the additional IP address previously assigned to the server
           with the add-ip command. If there is an A record for the IP address
           in DNS, it will be removed.
           Required Parameters: -s/--server-id, --ip
           Optional Parameters: none
   history
           Show history of operations on servers. If no particular server is
           specified then operations on all servers will be displayed.
           Required Parameters: none
           Optional Parameters: -s/--server-id, --depth
   help
           Show help.
           Required Parameters: none
           Optional Parameters: list, reserve, modify, release, history
DNS NAMES
       Please note that fully qualified DNS names must end with a dot ’.’. DNS
       names without the terminating dot will have the default DNS domain
       appended to them. You can list your DNS domains, determine which domain
       is the default domain, and change the default DNS domain with the
       command manage-dns-domain.
SERVER SIDE FILTERING
       You can use the -F option to filter the result set on the server side
       before the results are passed to the client. The value for the -F
       option is a perl expression which, when evaluates to true, causes the
       row to be included in the result set, and when false, it causes this
       row to be excluded from the result set passed to the client. You can
       further refine the displayed results using client side filtering and
       ordering options -f, -s, and -b. The perl expression is limited to
       using variables, comparison operators, regular expressions,
       parentheses, and a few other operations. Function calls and loops are
       not allowed. Variable names match column names with the dollar sign
       prepended to them as is customary in perl.
   Examples:
       manage-server list -F ’$id eq "NYM2:11399"’
           List only the server NYM2:11399.
       manage-server list -F ’$id =~ /AMS1/ && $status eq "available"’
           List available servers in the AMS1 datacenter.
       manage-server list -F ’$config eq "webe-2disk" && $status eq
       "available"’
           List available servers of the webe-2disk configuration.
DEPRECATED
       We have replaced underscores ’_’ with dashes ’-’ in all CLI parameter
       names to be more compliant with standard syntax. The following manage-
       server options are affected.
       Deprecated Parameters: --server_id
SEE ALSO
       manage-instance, manage-lb-ip, manage-lb-pool, manage-vlan, manage-
       gslb-zone, manage-gslb-domain, manage-gslb-group, manage-storage
0.486                             2018-02-13                  MANAGE-SERVER(1)