Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
No Format
      
MANAGE-VLAN(1)         AppNexus CLI Documentation v0.289        MANAGE-VLAN(1)



NAME
       manage-vlan - list/modify/get-stats VLANs, list/reserve/modify/release IP addresses

SYNOPSIS
       manage-vlan list [-s col_name | -b col_name] [-f filters] [-R]
       manage-vlan modify --vlan-id vlan_id -d description
       manage-vlan list-addresses [-a | -r | -u] [-s col_name | -b col_name] [-f filters] [-R]
       manage-vlan reserve-address --ip address [-d description]
       manage-vlan modify-address --ip address -d description
       manage-vlan release-address --ip address
       manage-vlan get-acl --vlan-id vlan_id [--file path]
       manage-vlan set-acl --vlan-id vlan_id (--file path | -) [--async] [--force]
       manage-vlan append-acl --vlan-id vlan_id (--file path | -) [--async]
       manage-vlan validate-acl (--file path | -)
       manage-vlan get-stats --vlan-id vlan_id --from-date date --to-date date
       manage-vlan history [--vlan-id vlan_id] [--depth number]
       manage-vlan command [--username username] [--password password]
       manage-vlan command -h
       manage-vlan (help | -h) [command]
       manage-vlan -V

DESCRIPTION
       This command lets you list your VLANs, modify VLAN descriptions, get VLANs bandwidth usage statis-
       tics, and list, reserve, modify, and release IP addresses in your VLANs. Reserving an IP address
       means it will not be used to launch an instance unless you explicitly specify it. You do not need to
       reserve an IP address from your VLAN before using it.

       This command is also used to manage VLAN Access Control Lists (ACLs). You can retrieve and change
       your VLAN ACL either completely or by appending new Access Control Entries (ACEs) to the existing
       ACL. Before changing the ACL you can use this tool to check the validity of new ACEs.

OPTIONS
       --vlan-id
           ID number of VLAN. Must be a composite string '<datacenter_id>:<vlan_id>', e.g. 'NYM1:1',
           'LAX1:210'.

       --ip
           IP address to reserve, release, or modify. Must be a composite string '<datacen-
           ter_id>:<ip_address>', e.g. 'NYM1:192.168.128.1', 'LAX1:192.168.128.2'.

       -a, --available
           List available IP addresses in your VLANs.

       -r, --reserved
           List IP addresses that you have already reserved.

       -u, --used
           List IP addresses that are in use.

       -d, --description
           Optional custom description to attach to the VLAN or IP address.

       --file
           Path to a file that is used for either uploading an ACL or ACE or for storing a retrieved ACL.
           This parameter is mutually exclusive with a lone dash (stdin).

       --force
           If user attempts to clear the VLAN ACL completely, they will be prompted to enter "--force" as a
           precaution.

       --from-date
           Beginning of time interval for get-stats command. Allowed format: YYYY-MM-DD.

       --to-date
           End of time interval for get-stats command. Allowed format: YYYY-MM-DD.

       --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.

       -s, --sort
           Column name(s) for sorting (ip_address, vlan_id, subnet, priority, state, instance_id, server_id,
           description). Use --sort <column_name1>{,<column_nameN>}.

       -b, --rsort
           Column name(s) for reverse sorting.

       -f, --filter
           Filter results by column name (ip_address, vlan_id, subnet, priority, state, instance_id,
           server_id, description). Use --filter <column_name1>=<pattern1>{,<patternN>} {<col-
           umn_name2>=<pattern2>{,<patternN>} where {} indicates an optional parameter. Do not use a space
           between multiple patterns. For example, --filter state=reserved,available.

       -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 all VLANs belonging to the customer.

           Required Parameters: none
           Optional Parameters: (-s/--sort | -b/--rsort), -f/--filter, -R/--raw

       modify

           Modify the description of a particular VLAN.

           Required Parameters: --vlan-id, -d/--description
           Optional Parameters: none

       list-addresses

           List all available IP addresses. Output includes VLAN ID; state (used by instance, used by
           server, available, or reserved); instance ID if applicable; server ID if applicable; and descrip-
           tion, if you have added one.

           Required Parameters: none
           Optional Parameters: (-a/--available | -r/--reserved | -u/--used), (-s/--sort | -b/--rsort),
           -f/--filter, -R/--raw

       reserve-address

           Reserve IP address from being automatically used for instance launch. You still can launch an
           instance with an already reserved IP address: pass the optional parameter '--ip' for the 'man-
           age-instance launch' command.

           Required Parameters: --ip
           Optional Parameters: -d/--description

       modify-address

           Change or add a description for an IP address.

           Required Parameters: --ip, -d/--description
           Optional Parameters: none

       release-address

           Release a previously reserved IP address.

           Required Parameters: --ip
           Optional Parameters: none

       get-acl

           Show VLAN ACL. You can pass the optional parameter '--file' for storing the ACL in file.

           Required Parameters: --vlan-id
           Optional Parameters: --file

       set-acl

           Set VLAN ACL completely, overwriting the current ACL. If user attempts to clear the ACL by sub-
           mitting a blank file or blank standard input (stdin), they will be prompted to enter "--force" as
           a precaution.  The syntax of the ACL is validated, but ACL is not validated for functional cor-
           rectness.

           Required Parameters: --vlan-id, (--file | -)
           Optional Parameters: --async, --force

       append-acl

           Append ACE(s) to the end of the existing VLAN ACL. Will not affect existing ACEs. The syntax of
           the addition is validated, but the ACL is not validated for functional correctness.

           Required Parameters: --vlan-id, (--file | -)
           Optional Parameters: --async

       validate-acl

           Validate syntax and semantics of ACE(s).

           Required Parameters: (--file | -)
           Optional Parameters: none

       get-stats

           Show VLAN bandwidth usage statistics (megabits per second in/out) during the specified time
           interval (maximum is one month).

           Required Parameters: --vlan-id, --from-date, --to-date
           Optional Parameters: none

       history

           Show history of operations on VLANs. If no particular VLAN is specified then operations on all
           VLANs will be displayed.

           Required Parameters: none
           Optional Parameters: --vlan-id, --depth

       help

           Show help.

           Required Parameters: none
           Optional Parameters: list, modify, list-addresses, reserve-address, modify-address,
           release-address, get-acl, set-acl, append-acl, validate-acl, get-stats, history

SEE ALSO
       manage-instance, manage-server, manage-lb-ip, manage-lb-pool, manage-cdn-domain, manage-gslb-zone,
       manage-gslb-domain, manage-gslb-group, manage-netezza-table, manage-storage



0.289                             2012-05-15                    MANAGE-VLAN(1)