Parameter | Description | Default |
---|
-f <flavor size> [dev | std] | Use this parameter to specify the flavor size for the SBC nodes in the deployment. For customer deployments, use the option standard (std) . | all sizes |
-h <ha type> [simplex | ha | n_1_ha] | Use this parameter to specify an HA model for the deployment. The options are: ha - to specify 1:1 HA redundancy.n_1_ha - to specify an N:1 HA deployment. N can be up to 4 for S-SBC and M-SBC deployments. Use this parameter with the --num_instances parameter which specifies the number of instances in the deployment.simplex - to specify a standalone instance for a test environment.
| all HA models |
-i <interface type> [virtio | sriov | provider] | Use this parameter to specify the network interface type for your deployment. The options are: provider - to specify a provider network.sriov - to specify an SR-IOV (single root input/output virtualization) network.virtio - to specify a virtio network.
| all interface types |
-p <prod_version> | Use this parameter to specify the SBC product version number. This parameter is required. Provide the full release number within quote marks. For example: -p "8.01.00" | n/a |
-q <qcow_image_file> | Include this parameter to specify that you want to include the SBC software .qcow2 image file within the CSAR package. Including the image file greatly increases the size of the CSAR file and is not required by VNFM. If you use this option, specify the name of the image file following the -q parameter. | no image file |
-s <subversion> | Use this parameter to specify the SBC release number. This parameter is required. Provide the release number within quote marks. For example: -s "R000" | n/a |
-v <vnfd_template> | Include this parameter to specify the full path and the name of the VNFD template file. If the template file resides in the same directory as the script, the -v parameter is not needed. | current directory |
--cinder_boot | Include this parameter to specify that you want to allocate create a bootable cinder Cinder volume and copy the boot image (the .qcow2 image) to that volume before starting the VM. By default no cinder boot volume is created. Activating this option causes the initial boot time to increase significantly. Use the --cinder_oam_DISK and --cinder_sbc_DISK options to specify the Cinder boot volume sizes. Note: The ephemeral disk size is set to 0 by default when you enable creating a Cinder boot volume. | no Cinder no cinder boot volume |
--cinder_log | Include this parameter to specify that you want to allocate create a cinder Cinder volume to use for /var/log. By default no cinder Cinder log volume is created. This option may be used to re-associate the /var/log directory tree from a previous orchestration to a new orchestration, by specifying that boot volume during orchestration. Note: Use the --cinder_log_DISK option to specify a size for the Cinder log volume. | no Cinder log volume |
--cinder_log_DISK <disk_gb> --cinder_oam_DISK <disk_gb> --cinder_sbc_DISK <disk_gb> | Include these parameters to specify the disk sizes for the Cinder volumes if you specify to create a Cinder boot volume or a Cinder log volume for storing log files and CDRs. If you are creating a log volume, consider the following formula to determine a minimum volume size to accommodate CDRs, and then add approximately 60GB for log and core files: (40% of peak CPS) * (records/call) * 86400 * (days) * 2K where: CPS is calls per second records per call is typically one or two, and depends on your deployment 86400 is the number of seconds per day days is the number of days of CDR records to store | boot volume: default disk size based on specified flavor log volume: 30 GB |
--ha_io_type [virtio | sriov | provider] | Include this parameter to override the general -i interface type configuration and specify a different type of interface for the HA network. | not enabled |
--image_name <image_name> | Include this parameter to specify the name of the SBC software qcow2 image file you are uploading to the Glance image repository so that name appears in the VNFD file. By default a name is derived by joining the values you specify for the product (-p ) and the version (-s ). Note that the image name must exactly match the name of the image in Glance to allow VNFM to load the image. | make image name from product (-p ) and version (-s ) strings |
--ipv6 | Include this parameter to specify that you want to use IPv6 addressing for the networks in your deployment. | IPv4 |
--mgt_io_type [virtio | sriov | provider] | Include this parameter to override the general -i interface type configuration and specify a different type of interface for the management network. | not enabled |
--mgt_vip
| Include this parameter if you want to add a virtual IP address to the management interface. The interface type must not be virtio. | no virtual IP address is added to the management interface |
--num_oam_instances <num_oam_instances> | Include this parameter to specify the number of OAM node instances to create within an N:1 HA deployment that will use the OAM configuration model. For example, specify 2 to create a 1:1 HA pair of OAM nodes. For deployments that will use the Direct Single configuration model (standalone or 1:1 HA deployments), the default value of 0 applies because OAM nodes are not required. Refer to SBC SWe Configuration Management for descriptions of both models. | 0 |
--num_instances <number> | Use this parameter to specify the number of SBC instances to create within the redundancy groups in an N:1 HA deployment. The default value is 5 which creates a 4:1 HA deployment. | 5 |
--num_sbc_rg <num_sbc_rg> | Use this parameter to specify the number of SBC redundancy groups to create within the VNF. The range allowed is 1 to 8. See Creating Multiple Redundancy Groups that Use the Same OAM Nodes for the procedure to create multiple redundancy groups. | 1 |
--personality [isbc | msbc | ssbc | tsbc | mrfp | slb ] | Use this parameter to specify the type of deployment to create. The options are: isbc - integrated SBC deploymentmsbc - media SBC component of a distributed SBC deploymentssbc - signaling SBC component of a distributed SBC deploymenttsbc - media/transcoding SBC component of a distributed SBC deploymentmrfp - media resource function processor (MRFP) nodeslb - SIP-aware front-end load-balancer node
| all types |
--pkt_vip | Include this parameter if you want to add a virtual IP addresses to the packet interfaces. The interface type must not be virtio. | no virtual IP addresses are added to the packet interfaces |
--prov_mgmt_virtio | This option is deprecated. Use "--mgmt_io_type virtio" instead. | not enabled |
--sbc_tar [<file> | omit] | Include this parameter to specify the path and file name for an input tar file, or use omit to not include a file. Specifying a tar file is currently not required. | omit |
--sbc_public_key <file> | Include this parameter to specify a path and name for a file containing a default public key to provide in the Cloud Config Init Data section during VNF instantiation. A public key is required to use SSH to access the deployed SBC. Specifying a key file with this parameter makes the key available as the default when a user deploys a VNF using the generated CSAR file. A user can still override the default with a different key when deploying. | Example: id_rsa.pub |
--security_restrict | Include this parameter to have the recommended security rules created automatically during orchestration.. Refer to Creating Security Group Rules for the list. If you use this option, your tenant must a large enough quota for the supplied security rules. The quota requirement increases if your deployment includes OAM VMs and when it supports both IPv4 and IPv6. A basic IPv4 SBC deployment requires 54 rules, while a deployment that includes OAM VMs and supports IPv4 and IPv6 requires 196 rules. | not enabled |
--vCPU <num_vCPU> --RAM <ram_mb> --DISK <disk_gb> | The flavor you select for an SBC VM defines the default values for sizing the VM when it is instantiated. Include these parameters to override one or more of the default values for VM sizing with a different value that you specify. The --DISK option applies to the ephemeral disk size. | various |
--oam_vCPU <num_vCPU> --oam_RAM <ram_mb> --oam_DISK <disk_gb> | Include these parameters to override one or more of the default sizing values for OAM nodes with a different value that you specify. There are various default values for these sizes, depending on the options selected. For std flavor deployments, OAM nodes have a size of vCPU=4, RAM=16 GiB, DISK=80 GB. For dev flavor deployments, OAM nodes have the same size as other VMs: vCPU=4, RAM=10GiB, DISK=80 GB. The --oam_DISK option applies to the ephemeral disk size. | various |