boot_uas.py Help

./boot_uas.py --help
usage: boot_uas.py [-h] [--version] [--hostname HOSTNAME]
                   [--delete DELETE [DELETE ...]] [--recover RECOVER]
                   [--delete-uas] [--upgrade-uas] [--upgrade UPGRADE] [--json]
                   [--openstack] [--kvm] [--autodeploy] [--autoit] [--autovnf]
                   [--os_auth_url OS_AUTH_URL]
                   [--os_tenant_name OS_TENANT_NAME]
                   [--os_tenant_id OS_TENANT_ID]
                   [--os_project_name OS_PROJECT_NAME]
                   [--os_project_id OS_PROJECT_ID]
                   [--os_project_domain_name OS_PROJECT_DOMAIN_NAME]
                   [--os_project_domain_id OS_PROJECT_DOMAIN_ID]
                   [--os_username OS_USERNAME] [--os_user_id OS_USER_ID]
                   [--os_password OS_PASSWORD]
                   [--os_user_domain_name OS_USER_DOMAIN_NAME]
                   [--os_user_domain_id OS_USER_DOMAIN_ID]
                   [--os_identity_api_version OS_IDENTITY_API_VERSION]
                   [--net NET [NET ...]] [--ip [IPADDR [IPADDR ...]]]
                   [--orch-interface ORCH_INTF] [--gateway DEFAULT_GW]
                   [--gateway_if DEFAULT_GW_IDX] [--ha] [--ha-vip HA_VIP]
                   [--ha-net HA_VIP_NET] [--ha-secret HA_SECRET]
                   [--floating-ip [FLOATING_IP]]
                   [--external-network PUBLICNET] [--flavor FLAVOR]
                   [--avail_zone AVAIL_ZONE] [--image IMAGE]
                   [--ssh_key_file SSH_KEY_FILE] [--password PASSWORD]
                   [--admin ADMIN] [--oper OPER] [--security SECURITY]
                   [--syslog-ip SYSLOG_SERVER_IP] [--port SYSLOG_SERVER_PORT]
                   [--severity SYSLOG_SEVERITY]

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --hostname HOSTNAME   Hostname prefix
  --delete DELETE [DELETE ...]
                        Delete UAS deployment. Applicable only for OpenStack
  --recover RECOVER     Recover UAS deployment.
  --delete-uas          Deletes the UAS deployment. Applicable only for KVM
  --upgrade-uas         Rolling Upgrade for uas deployment. Applicable only
                        for KVM
  --upgrade UPGRADE     Rolling Upgrade for UAS deployment. Applicable only
                        for OpenStack.
  --json                Output Data in JSON

Specify the infrastructure to be used for the UAS VM:
  --openstack           Use Openstack Infrastructure
  --kvm                 Use KVM Infrastructure

Specify the type of UAS VM to be instantiated:
  --autodeploy          Boot AutoDeploy UAS type
  --autoit              Boot AutoIT UAS type
  --autovnf             Boot AutoVNF UAS type

OpenStack configuration to instantiate AutoVNF cluster.
You can either source RC file or provide them on command line:
  --os_auth_url OS_AUTH_URL
                        OS Auth-URL, defaults to env[OS_AUTH_URL].
  --os_tenant_name OS_TENANT_NAME
                        OS Tenant Name, defaults to env[OS_TENANT_NAME].
  --os_tenant_id OS_TENANT_ID
                        OS Tenant ID, defaults to env[OS_TENANT_ID].
  --os_project_name OS_PROJECT_NAME
                        OS Project Name, defaults to env[OS_PROJECT_NAME].
  --os_project_id OS_PROJECT_ID
                        OS Project ID, defaults to env[OS_PROJECT_ID].
  --os_project_domain_name OS_PROJECT_DOMAIN_NAME
                        OS Project Domain Name, defaults to
                        env[OS_PROJECT_DOMAIN_NAME].
  --os_project_domain_id OS_PROJECT_DOMAIN_ID
                        OS Project Domain ID, defaults to
                        env[OS_PROJECT_DOMAIN_ID].
  --os_username OS_USERNAME
                        OS Username, defaults to env[OS_USERNAME].
  --os_user_id OS_USER_ID
                        OS User ID, defaults to env[OS_USER_ID].
  --os_password OS_PASSWORD
                        OS Password, defaults to env[OS_PASSWORD].
  --os_user_domain_name OS_USER_DOMAIN_NAME
                        OS User Domain Name, defaults to
                        env[OS_USER_DOMAIN_NAME].
  --os_user_domain_id OS_USER_DOMAIN_ID
                        OS User Domain ID, defaults to env[OS_USER_DOMAIN_ID].
  --os_identity_api_version OS_IDENTITY_API_VERSION
                        OS Identity API Version, defaults to
                        env[OS_IDENTITY_API_VERSION].

Networks to be used, first network is used as orchestration:
  --net NET [NET ...]   Ordered list of networks (name or uuid) to attach to
                        AutoVNF Cluster.
  --ip [IPADDR [IPADDR ...]]
                        Static IP, default is DHCP
  --orch-interface ORCH_INTF
                        Orchestration Interface

Default gateway parameters.:
  --gateway DEFAULT_GW  Default Gateway IP Address, needed only in case of
                        static IP
  --gateway_if DEFAULT_GW_IDX
                        Interface index to associate default route, default is
                        first interface.

High-Availability parameters:
  --ha                  Enable High-Availability
  --ha-vip HA_VIP       Virtual IP Address (VIP) for cluster
  --ha-net HA_VIP_NET   Network used to assign the VIP address
  --ha-secret HA_SECRET
                        HA Secret for the cluster

Floating IP Parameters:
  --floating-ip [FLOATING_IP]
                        Enable floating IP association to VIP port
  --external-network PUBLICNET
                        External Network to allocate floating IP.

VM specific parameters:
  --flavor FLAVOR       VM Flavor (name or uuid), default is 'm1.medium'
  --avail_zone AVAIL_ZONE
                        The availability zone for AutoVNF placement.
  --image IMAGE         Image name or UUID from VIM or location of the qcow2
                        image file

AutoVNF VM Login Parameters, if not provided, user will be prompted:
  --ssh_key_file SSH_KEY_FILE
                        Path to SSH key file to be used as authorised key for
                        login as 'ubuntu'
  --password PASSWORD   Password for login as 'ubuntu', this is required if
                        SSH key is not provided

AutoVNF API Access parameters, if not provided, user will be prompted:
  --admin ADMIN         Password for AutoVNF admin user.
  --oper OPER           Password for AutoVNF oper user
  --security SECURITY   Password for AutoVNF security user

Syslog Configuration Parameters:
  --syslog-ip SYSLOG_SERVER_IP
                        Remote syslog server IP address
  --port SYSLOG_SERVER_PORT
                        Remote syslog server port
  --severity SYSLOG_SEVERITY
                        Severity of syslog