Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
No Format

MANAGE-VLAN(1)         AppNexus CLI Documentation v0.180486        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 perl_expression] [-f
       filters] [ --oc col_name ] [-R]
       manage-vlan modify --vlan-id vlan_id -d description
       manage-vlan list-dns [-r | -u] [-s col_name | -b col_name] [-F
       perl_expression] [-f filters] [ --oc col_name ] [-R]
       manage-vlan modify-dns --ip address --dns dns_name
       manage-vlan list-addresses [-a | -r | -u] [-s col_name | -b col_name]
       [-F perl_expression] [-f filters] [ --oc col_name ]    [-R] [-v]
       manage-vlan reserve-address --ip address [-d description] [ --dns
       dns_name ]
       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 statistics, and list, reserve, modify, and
release IP      release IP addresses in your VLANs. Reserving an IP address means it
will not be used to launch  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
  address from your VLAN before using it.
        This command is also used to manage VLAN Access Control Lists (ACLs).
You can      You can retrieve and change your VLAN ACL either completely or by
appending new Access Con-    appending new Access Control trol 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.          ’<datacenter_id>:<vlan_id>’,  'NYM1:1', 'LAX1:210'e.g. ’NYM1:1’, ’LAX1:210’.
        --ip
           IP address to reserve, release, or modify. Must be a composite
string '<datacen-          string  ter’<datacenter_id>:<ip_address>'address>’, e.g. 'NYM1’NYM1:192.168.128.1'1’,
'LAX1           ’LAX1:192.168.128.2'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 used by your instancesin use.
        -d, --description
           Optional custom description to attach to the VLAN or IP address.
       --dns
           The desired DNS name for the IP address. See the section DNS NAMES
           below for more details.
       --file
           Path to a file that is used for either uploading an ACL or ACE or
for storing a         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          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.
       -v, --verbose
           Output data in verbose mode.
       -s, --sort
           Column name(s) for sorting (ip_address, vlan_id, subnet, priority,
state,           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,          priority, state, instance_id, server_id, description). Use --filter
           <column_name1>=<pattern1>{,<patternN>}
           {<column_name2>=<pattern2>{,<patternN>} where {} indicates an
optional parame-          optional  terparameter. Do not use a space between multiple patterns.
           For example, --filter state=reserved,available.
       -F,   state=reserved,available.

       ---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 all VLANs belonging to the customer.
            Required Parameters: none
           Optional Parameters: (-s/--sort | -b/--rsort),
           -F/--server-side-filter, -f/--filter, --oc, -R/--raw
   modify
    list-addresses       Modify the description of a particular VLAN.
           Required Parameters: --vlan-id, -d/--description
           Optional Parameters: none
   list-dns
            List all availablereserved or used IP addresses. Output includes VLAN ID;
           state (used, avail-
    by instance, used by server, or reserved); instance ID
           if applicable; server ID if applicable; and DNS name associated
           with the IP address.
           Required Parameters: none
           Optional Parameters: (-r/--reserved | -u/--used), (-s/--sort |
       able, or reserved);     -b/--rsort), -F/--server-side-filter, -f/--filter, --oc, -R/--raw
   modify-dns
           Modify the DNS name for the specified reserved or used IP address.
           Required Parameters: --ip, --dns
           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
           description, if you have added one. Verbose output additionally
      added one.

          includes device_id (which is useful for IPs assigned to network
           devices, i.e. not instances or servers); dns_name (FQDN) if
           applicable; and device_name.
           Required Parameters: none
           Optional Parameters: (-a/--available | -r/--reserved | -u/--used),
(-s/--sort |          (-s/--sort | -b/--rsort), -fF/--server-side-filter, -Rf/--rawfilter,
           --oc, -R/--raw, -v/--verbose
   reserve-address
            Reserve IP address from being automatically used for instance
launch. You still         launch. You still can launch an instance with an already reserved
           IP address: pass the optional parameter ’--ip’ for the
       parameter '--ip' for the 'manage-instance launch' command.

              ’manage-instance launch’ command. A new A record will be added to
           DNS for the newly reserved IP address. You can use the --dns option
           to specify the DNS name. The default DNS name is ipNNN.DC.DD where
           NNN is a number assigned by the cloud API, DC is the datacenter ID,
           and DD is the customer default DNS domain.
           Required Parameters: --ip
           Optional Parameters: -d/--description, --dns
       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. If a DNS record for the
           reserved address exists, it will be removed.
           Required Parameters: --ip
           Optional Parameters: none
        get-acl
            Show VLAN ACL. You can pass the optional parameter '--file'file’ for
storing the ACL         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         attempts to clear the ACL by submitting a blank file or blank
standard input (stdin), they will be      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 correctness.
           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           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: none--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          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,
       release-address    validate-acl, get-stats, 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-vlan list -F ’$id eq "LAX1:100"’
           List only the VLAN LAX1:100.
       manage-vlan list -F ’$priority eq "disabled" && !$description’
           List disabled VLANs with no description.
       manage-vlan list-addresses -F ’$vlan_id eq "LAX1:2030"’
           List addresses for the VLAN LAX1:2030.
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-storage
0.180486                             20092018-0702-0913                    MANAGE-VLAN(1)