OVA Descriptor File Properties

Transcription

1 All required and optional properties for the OVA descriptor file are described here. RMS Network Architecture, page 1 Virtual Host Network Parameters, page 2 Virtual Host IP Address Parameters, page 4 Virtual Machine Parameters, page 8 HNB Gateway Parameters, page 9 Auto-Configuration Server Parameters, page 11 OSS Parameters, page 11 Administrative User Parameters, page 15 BAC Parameters, page 16 Certificate Parameters, page 17 Deployment Mode Parameters, page 18 License Parameters, page 18 Password Parameters, page 19 Serving de GUI Parameters, page 21 DPE CLI Parameters, page 21 Time Zone Parameter, page 21 RMS Network Architecture The descriptor are used to describe to the RMS system the network architecture being used so that all network entities can be accessed by the RMS. Before you create your descriptor you must have on hand the es of the various nodes in the system, the VLAN numbers and all other information being configured in the descriptor. Use this network architecture diagram as an example of a typical RMS installation. The examples in this document use the es defined in this architecture diagram. It might May 25, 2015 HF 1

2 Virtual Host Network Parameters be helpful to map out your RMS architecture in a similar manner and thereby easily replace the values in the descriptor example provided here to be applicable to your installation. Figure 1: RMS Architecture Virtual Host Network Parameters This section of the OVA descriptor file specifies the virtual host network architecture. Information must be provided regarding the VLANs for the ports on the central node, the serving node and the upload node. The virtual host network property contains the parameters described in this table. te VLAN numbers correspond to the network diagram in RMS Network Architecture, on page 1. Name: Description Central-node Network 1 VLAN for the connection between the central node (southbound) and the upload node VLAN # In all-in-one deployment descriptor file In distributed central node descriptor file net:central-de Network 1=VLAN 11 2 May 25, 2015 HF

3 Virtual Host Network Parameters Name: Description Central-node Network 2 VLAN for the connection between the central node (northbound) and the serving node VLAN # In all-in-one deployment descriptor file In distributed central node descriptor file net:central-de Network 2=VLAN 2335K Serving-node Network 1 VLAN for the connection between the serving node (northbound) and the central node VLAN # In all-in-one deployment descriptor file In serving node descriptor file for distributed deployment net:serving-de Network 1=VLAN 11 Serving-node Network 2 VLAN for the connection between the serving node (southbound) and the CPE network (FAPs) VLAN # In all-in-one deployment descriptor file In distributed serving node descriptor file net:serving-de Network 2=VLAN 12 Upload-node Network 1 VLAN for the connection between the upload node (northbound) and the central node VLAN # In all-in-one deployment descriptor file In distributed upload node descriptor file net:upload-de Network 1=VLAN 11 Upload-node Network 2 VLAN for the connection between the upload node (southbound) and the CPE network (FAPs) VLAN # In all-in-one deployment descriptor file In distributed upload node descriptor file net:upload-de Network 2=VLAN 12 Virtual Host Network Configuration of virtual host network section for all-in-one deployment: net:upload-de Network 1=VLAN 11 net:upload-de Network 2=VLAN 12 net:central-de Network 1=VLAN 11 net:central-de Network 2=VLAN 2335K net:serving-de Network 1=VLAN 11 net:serving-de Network 2=VLAN 12 of virtual host network section for distributed central node: net:central-de Network 1=VLAN 11 net:central-de Network 2=VLAN 2335K May 25, 2015 HF 3

4 Virtual Host IP Address Parameters of virtual host network section for distributed upload node: net:upload-de Network 1=VLAN 11 net:upload-de Network 2=VLAN 12 of virtual host network section for distributed serving node: net:serving-de Network 1=VLAN 11 net:serving-de Network 2=VLAN 12 Virtual Host IP Address Parameters This section of the OVA descriptor file specifies information regarding the virtual host. The Virtual Host IP Address property includes these parameters: te The column in the tables, Yes indicates Mandatory field, and indicates n-mandatory field. Underscore (_) cannot be used for the hostname for hostname parameters. Hostname Parameters Parameter Name: Description Valid / Default Central_Hostname Configured hostname of the server Character string; no periods (.) allowed rms-aio-central for all-in-one descriptor file, rms-distr-central for central node descriptor file Yes prop:central_hostname= hostname-central Serving_Hostname Configured hostname of the serving node Character string; no periods (.) allowed rms-aio-serving for distributed all-in-one descriptor file, rms-distr-serving for distributed descriptor file prop:serving_hostname= hostname-serving Upload_Hostname Configured hostname of the upload node Character string; no periods (.) allowed rms-aio-upload for all-in-one, rms-distr-upload for distributed prop:upload_hostname= hostname-upload 4 May 25, 2015 HF

5 Virtual Host IP Address Parameters Central de Parameters Name: Description Valid / Default Central_de_Eth0_Address of the southbound VM interface prop:central_de_eth0_address= Central_de_Eth0_Subnet Network mask for the IP subnet of the southbound VM interface Network mask prop:central_de_eth0_subnet= Central_de_Eth1_Address of the northbound VM interface prop:central_de_eth1_address= Central_de_Eth1_Subnet Network mask for the IP subnet of the northbound VM interface Network mask prop:central_de_eth1_subnet= Central_de_Gateway of the gateway to the management network for the northbound interface of the central node prop:central_de_gateway= Central_de_Dns1_Address of primary DNS server provided by network administrator prop:central_de_dns1_address= Central_de_Dns2_Address of secondary DNS server provided by network administrator prop:central_de_dns2_address= Serving de Name: Description Valid / Default Serving_de_Eth0_Address of the northbound VM interface prop:serving_de_eth0_address= May 25, 2015 HF 5

6 Virtual Host IP Address Parameters Name: Description Valid / Default Serving_de_Eth0_Subnet Network mask for the IP subnet of the northbound VM interface Network mask prop:serving_de_eth0_subnet= Serving_de_Eth1_Address of the southbound VM interface prop:serving_de_eth1_address= Serving_de_Eth1_Subnet Network mask for the IP subnet of the southbound VM interface Network mask prop:serving_de_eth1_subnet= Serving_de_Gateway of the gateway to the management network for the southbound interface of the serving node, can be specified in comma separated format in the form <NB GW>,<SB prop:serving_de_gateway= , Serving_de_Dns1_Address of primary DNS server provided by network administrator prop:serving_de_dns1_address= Serving_de_Dns2_Address of secondary DNS server provided by network administrator prop:serving_de_dns2_address= Upload de Name: Description Valid / Default Upload_de_Eth0_Address of the northbound VM interface prop:upload_de_eth0_address= Upload_de_Eth0_Subnet Network mask for the IP subnet of the northbound VM interface Network mask prop:upload_de_eth0_subnet= May 25, 2015 HF

7 Virtual Host IP Address Parameters Name: Description Valid / Default Upload_de_Eth1_Address of the southbound VM interface prop:upload_de_eth1_address= Upload_de_Eth1_Subnet Network mask for the IP subnet of the southbound VM interface Network mask prop:upload_de_eth1_subnet= Upload_de_Gateway of the gateway to the management network for the southbound interface of the upload node, can be specified in comma separated format in the form <NB GW>,<SB GW> prop:upload_de_gateway= , Upload_de_Dns1_Address of primary DNS server provided by network administrator prop:upload_de_dns1_address= Upload_de_Dns2_Address of secondary DNS server provided by network administrator prop:upload_de_dns2_address= Virtual Host IP Address s All-in-one Descriptor File : prop:central_de_eth0_address= prop:central_de_eth0_subnet= prop:central_de_eth1_address= prop:central_de_eth1_subnet= prop:central_de_dns1_address= prop:central_de_dns2_address= prop:central_de_gateway= prop:serving_de_eth0_address= prop:serving_de_eth0_subnet= prop:serving_de_eth1_address= prop:serving_de_eth1_subnet= prop:serving_de_dns1_address= prop:serving_de_dns2_address= prop:serving_de_gateway= , prop:upload_de_eth0_address= prop:upload_de_eth0_subnet= prop:upload_de_eth1_address= prop:upload_de_eth1_subnet= May 25, 2015 HF 7

8 Virtual Machine Parameters prop:upload_de_dns1_address= prop:upload_de_dns2_address= prop:upload_de_gateway= , Distributed Serving de Descriptor File : prop:serving_de_eth0_address= prop:serving_de_eth0_subnet= prop:serving_de_eth1_address= prop:serving_de_eth1_subnet= prop:serving_de_dns1_address= prop:serving_de_dns2_address= prop:serving_de_gateway= , Distributed Upload de Descriptor File : prop:upload_de_eth0_address= prop:upload_de_eth0_subnet= prop:upload_de_eth1_address= prop:upload_de_eth1_subnet= prop:upload_de_dns1_address= prop:upload_de_dns2_address= prop:upload_de_gateway= , Distributed Central de Descriptor File : prop:central_de_eth0_address= prop:central_de_eth0_subnet= prop:central_de_eth1_address= prop:central_de_eth1_subnet= prop:central_de_dns1_address= prop:central_de_dns2_address= prop:central_de_gateway= Virtual Machine Parameters The following virtual machine (VM) parameters can be configured. te Make sure that the value of the parameter poweron is set to false as the VMware hardware version needs to be upgraded before starting the VMs. acceptalleulas True/False acceptalleulas=false Specifies to accept license agreements False skipmanifestcheck True/False skipmanifestcheck=true Specifies to skip validation of the OVF package manifest False poweron True/False poweron=false Specifies to set the VM state for the first time once deployed False 8 May 25, 2015 HF

9 HNB Gateway Parameters diskmode thick/thin diskmode=thin Logical disk type of the VM thin vmfolder folder name Yes vmfolder=fem-ga-pest Grouping virtual machine to add additional security datastore Yes datastore=ds-rtprms-c Name of the physical storage to keep VM name Yes name=rms-provisioning-solution Name of the vapp that will be deployed on the host VSC ovfid VM Parameter Configurations acceptalleulas=true skipmanifestcheck=true poweron=false diskmode=thin vmfolder=fem-ga-pest datastore=ds-rtprms-c name=rms-provisioning-solution HNB Gateway Parameters These parameters can be configured for the Cisco ASR 5000 hardware that is running the central and serving nodes in all descriptor. A post-installation script is provided to configure correct values for these parameters. For more information, refer to Configuring the HNB Gateway for Redundancy. IPSec address HNB-GW address DHCP pool information SCTP address Asr5k_Dhcp_Address DHCP of the ASR 5000 Yes, but can be configured with post-installation script prop:asr5k_dhcp_address= May 25, 2015 HF 9

10 HNB Gateway Parameters Asr5k_Radius_Address Radius of the ASR 5000 Yes, but can be configured with post-installation script prop:asr5k_radius_address= Asr5k_Radius_Secret prop:asr5k_radius_secret= *** Radius secret password as configured on the ASR 5000 secret Dhcp_Pool_Network DHCP Pool network address of the ASR 5000 Yes, but can be configured with post-installation script prop:dhcp_pool_network= Dhcp_Pool_Subnet Subnet mask of the DHCP Pool network of the ASR 5000 Network mask Yes, but can be configured with post-installation script prop:dhcp_pool_subnet= Dhcp_Pool_FirstAddress First of the DHCP pool network of the ASR 5000 Yes, but can be configured with post-installation script prop:dhcp_pool_firstaddress= Dhcp_Pool_LastAddress Last of the DHCP pool network of the ASR 5000 Yes, but can be configured with post-installation script prop:dhcp_pool_lastaddress= Asr5k_Radius_CoA_Port Port number prop:asr5k_radius_coa_port=3799 Port for RADIUS Change-of-Authorization (with white list updates) and Disconnect flows from the PMG to the ASR Upload_SB_Fqdn Southbound fully qualified domain name or for the upload node. For NAT based deployment, this can be set to public IP/FQDN of the NAT. Upload eth1 address Yes prop:upload_sb_fqdn= <Upload_Server_Hostname> HNB Gateway Configuration prop:asr5k_dhcp_address= May 25, 2015 HF

11 Auto-Configuration Server Parameters prop:asr5k_radius_address= prop:asr5k_radius_secret=secret prop:dhcp_pool_network= prop:dhcp_pool_subnet= prop:dhcp_pool_firstaddress= prop:dhcp_pool_lastaddress= prop:asr5k_radius_coa_port=3799 Auto-Configuration Server Parameters Configure the network virtual IP and the loopback address on the Central node, Serving node, and the Upload node. The loopback address is configured as the default router for the Serving de and the Upload de. The virtual and the virtual Fully Qualified Domain Name (FQDN) are used as Auto-Configuration Server (ACS) for TR-069 Informs, download of firmware, and upload of diagnostic. The virtual IP address and virtual FQDN should either point to ACE server or to the Serving node Southbound (South) address (if ACE is not used). te ACE hardware was used for TLS termination and load balancing. This hardware has reached end of life and not being deployed. For new installations, TLS is terminated on the DPE, thus bypassing the ACE. The following parameters are used to configure the auto-configuration server information: Acs_Virtual_Address ACS Virtual Address. Southbound of the Serving node In all descriptor prop:acs_virtual_address= Acs_Virtual_Fqdn ACS virtual fully qualified domain name (FQDN). Southbound FQDN or of the serving node. For NAT based deployment, this can be set to public IP/FQDN of the NAT. Domain name or In all descriptor prop:acs_virtual_fqdn= femtosetup11.testlab.com ACS Configuration prop:acs_virtual_address= prop:acs_virtual_fqdn=femtosetup11.testlab.com OSS Parameters Use these parameters to configure the integration points that are defined in the operation support systems (OSS). Only a few integration points must be configured, while others are optional. The optional integration points can be enabled or disabled using a Boolean flag. May 25, 2015 HF 11

12 OSS Parameters NTP Servers Use these parameters to configure the NTP server address defined for virtual hosts: te NTP servers can be configured after deploying the OVA. Refer to NTP Servers Configuration. Ntp1_Address prop:ntp1_address= <ip address> Primary NTP server Ntp2_Address prop:ntp2_address= <ip address> Secondary NTP server Ntp3_Address prop:ntp3_address= <ip address> Alternative NTP server Ntp4_Address prop:ntp4_address= <ip address> Alternative NTP server NTP Configuration prop:ntp1_address=<ip address> prop:ntp2_address=ntp-rtp2.cisco.com prop:ntp3_address=ntp-rtp3.cisco.com prop:ntp4_address= DNS Domain Use these parameters to configure the DNS domain for virtual hosts: Valid / Default Dns_Domain Configures the domain address for virtual hosts Domain address cisco.com prop:dns_domain=cisco.com DNS Configuration prop:dns_domain=cisco.com 12 May 25, 2015 HF

13 OSS Parameters Syslog Servers Use these parameters to configure the two syslog servers defined for remote logging support: Valid / Default Syslog_Enable True/False prop:syslog_enable=true Enables or disables syslog False Syslog1_Address Primary syslog server of syslog server prop:syslog1_address= Syslog2_Address Secondary syslog server IP address of syslog server prop:syslog2_address= te The syslog server configuration can be performed after the OVA file deployment. Refer to SYSLog Servers Configuration. Syslog Configuration prop:syslog_enable=true prop:syslog1_address= prop:syslog2_address= SNMP Use these parameters to configure the two Simple Network Management Protocol (SNMP) hosts that are defined. The SNMP hosts are allowed through the host-based firewall and configured in each of the applications that support SNMP polling. te The SNMP read and SNMP write communities are defined only if the SNMP "Read" and SNMP "Write" options are enabled. te The SNMP configuration can be performed after the OVA file deployment. Refer to Configuring the SNMP and SNMP Trap Servers. May 25, 2015 HF 13

14 OSS Parameters Valid / Default Snmp_Enable Enables or disables use of SNMP True/False; values other than True are treated as False prop:snmp_enable=true False Snmp_Read_Community SNMP read password snmp-read prop:snmp_read_community=*** Snmp_Write_Community SNMP write password snmp-write prop:snmp_write_community=*** Snmp1_Address prop:snmp1_address= of primary SNMP server Snmp2_Address prop:snmp2_address= of secondary SNMP server SNMP Configuration prop:snmp_enable=true prop:snmp_read_community=*** prop:snmp_write_community=*** prop:snmp1_address= prop:snmp2_address= SNMP Traps Use these parameters to configure two SNMP trap hosts defined for real-time alarming. Each application that supports SNMP traps are configured with the hosts and the community string. te The SNMP trap configuration can be performed after the OVA file deployment. Refer to Configuring the SNMP and SNMP Trap Servers. 14 May 25, 2015 HF

15 Administrative User Parameters Valid / Default Snmptrap_Enable Enables or disables use of SNMP trap service for real-time alarming True/False; values other than True are treated as False False prop:snmptrap_enable=true Snmptrap1_Address of primary SNMP trap server prop:snmptrap1_address= Snmptrap2_Address of secondary SNMP trap server prop:snmptrap2_address= Snmptrap_Community SNMP trap community password snmp-trap prop:snmptrap_community= snmp-trap SNMP Trap Configuration prop:snmptrap_enable=true prop:snmptrap1_address= prop:snmptrap2_address= prop:snmptrap_community=snmp-trap Administrative User Parameters Use these parameters to define the RMS administrative user. Configuring the administrative user ensures that accounts are created for all the software components such as Broadband Access Center Database (BAC DB), Cisco Prime Network Registrar (PNR), Cisco Prime Access Registrar (PAR), and Secure Shell (SSH) system accounts. The user administration is an important security feature and ensures that management of the system is performed using non-root access. One admin user is defined by default during installation. You can change the default with these parameters. Other users can be defined after installation using the DCC UI. te LINUX users can be added using the appropriate post-configuration script. Refer to Configuring Linux Administrative Users. May 25, 2015 HF 15

16 BAC Parameters Admin1_Username prop:admin1_username=admin1 System Admin user 1 login id admin1 Admin1_Password System Admin user 1 password Passwords must be mixed case, alphanumeric, characters long and contain one of the special characters (*,@,#), at least one numeral and no spaces. prop:admin1_password=*** Ch@ngeme1 Admin1_Firstname System Admin user 1 first name admin1 prop:admin1_firstname= Admin1_Firstname Admin1_Lastname System Admin user 1 last name admin1 prop:admin1_lastname= Admin1_Lastname BAC Parameters These BAC parameters can be optionally configured in the descriptor file: Bac_Provisioning_Group Name of default provisioning group which gets created in the BAC pg01 prop:bac_provisioning_group= default 16 May 25, 2015 HF

17 Certificate Parameters Ip_Timing_Server_Ip IP-TIMING-SERVER-IP property of the provisioning group specified in this descriptor. If there is no IP timing configured then provide a dummy IP address for this parameter, something like prop:ip_timing_server_ip= Certificate Parameters The CPE-based security for the RMS solution is a private key, certificate-based authentication system. Each Small Cell and server interface requires a unique signed certificate with the public DNS name and the defined. System_Location prop:system_location= Production System Location used in SNMP configuration Production System_Contact System contact used in SNMP configuration address Contact@Customer.com prop:system_contact= Contact@Customer.com Cert_C prop:cert_c=us Certificate parameters to generate a Certificate Signing Request (CSR): Country name US Cert_ST prop:cert_st= rth Carolina Certificate parameters to generate csr: State or Province name NC Cert_L prop:cert_l=rtp Certificate parameters to generate csr: Locality name RTP Cert_O prop:cert_o= Cisco Systems, Inc. Certificate parameters to generate csr: Organization name Cisco Systems, Inc. May 25, 2015 HF 17

18 Deployment Mode Parameters Cert_OU prop:cert_ou= SCTG Certificate parameters to generate csr: Organization Unit name MITG Deployment Mode Parameters Use these parameters to specify deployment modes. Secure mode is set to True by default, and is a required setting for any production environment. Secure_Mode True/False prop:secure_mode=true Ensures that all the security options are configured. The security options include IP Tables and secured "sshd" settings. True License Parameters Use these parameters to configure the license information for the Cisco BAC, Cisco Prime Access Registrar and Cisco Prime Network Registrar. Default or mock licenses are installed unless you specify these parameters with actual license values. Valid / Default Bac_License_Dpe: License for BAC DPE A default dummy license is provided prop:bac_license_dpe=aafa... Bac_License_Cwmp: License for BAC CWMP A default dummy license is provided prop:bac_license_cwmp=aafa... Bac_License_Ext: License for BAC DPE extensions A default dummy license is provided prop:bac_license_ext=aafa May 25, 2015 HF

19 Password Parameters Bac_License_FemtoExt: License for BAC DPE extensions te License should be of PAR type and not SUB type Valid / Default A default dummy license is provided prop:bac_license_femtoext=aafa... Car_License_Base: License for Cisco PAR A default dummy license is provided prop:bac_license_cwmp=aafa... Cnr_License_IPde: License for Cisco PNR A default dummy license is provided prop:bac_license_cwmp=aafa... te For the PAR and PNR licenses, the descriptor properties Car_License_Base and Cnr_License_IPde need to be updated in case of multi-line license file. (Put '/n' at the start of new line of the license file) For example: prop:cnr_license_ipde=increment count-dhcp cisco 8.1 uncounted VENDOR_STRING=<Count>10000</Count> HOSTID=ANY NOTICE="<LicFileID> </LicFileID><LicLineID>1</LicLineID> <PAK></PAK><CompanyName></CompanyName>" SIGN=176CCF90B694 \nincrement base-dhcp cisco 8.1 uncounted VENDOR_STRING=<Count>1000</Count> HOSTID=ANY NOTICE="<LicFileID> </LicFileID><LicLineID>2</LicLineID> <PAK></PAK><CompanyName></CompanyName>" SIGN=0F10E6FC871E Password Parameters The password for the root user to all virtual machines (VM) can be configured through the deployment descriptor. If this property is not set, the default root password is Ch@ngeme1. However, it is strongly recommended to set the Root_Password through the deployment descriptor file. The RMS_App_Password configures access to all of the following applications with one password: BAC admin password DCC application Operations tools ciscorms user password DCC administration May 25, 2015 HF 19

20 Password Parameters Postgres database Central keystore Upload statistics Upload call drop Upload demand Upload lost IPsec Upload lost gateway connection Upload network location scan Upload periodic Upload restart Upload crash Upload low memory Upload unknown Root_Password prop:root_password=*** Password of the root user for all RMS VMs RMS_App_Password Password of the root user for all RMS VMs Passwords must be mixed case, alphanumeric, characters long and contain one of the special characters at least one numeral and no spaces. prop:rms_app_password=*** Password Configuration prop:root_password=cisco123 prop:rms_app_password=newpswd# May 25, 2015 HF

21 Serving de GUI Parameters Serving de GUI Parameters The serving node GUI for Cisco PAR and Cisco PNR is disabled by default. You can enable it with this parameters. Valid / Default Serving_Gui_Enable: Option to enable/disable GUI of PAR and PNR True/False; values other than "True" treated as "False." False prop:serving_gui_enable=false DPE CLI Parameters The properties of the DPE command line interface (CLI) on the serving node can be configured through the deployment descriptor file with this parameter. Dpe_Cnrquery_Client_ Socket_Address Address and port of the CNR query client configured in the DPE followed by the port serving eth0 addr:61611 prop: Dpe_Cnrquery_Client_Socket_Address= :61611 DPE CLI Configuration prop:dpe_cnrquery_client_socket_address= :61611 Time Zone Parameter You can configure the time zone of the RMS installation with this parameter. May 25, 2015 HF 21

22 Time Zone Parameter Parameter Name: Description prop:vamitimezone Etc/UTC prop:vamitimezone=etc/utc Default time zone Supported values: Pacific/Samoa US/Hawaii US/Alaska US/Pacific US/Mountain US/Central US/Eastern America/Caracas America/Argentina/Buenos_Aires America/Recife Etc/GMT-1 Etc/UTC Europe/London Europe/Pari Africa/Cairo Europe/Moscow Asia/Baku Asia/Karachi Asia/Calcutta Asia/Dacca Asia/Bangko Asia/Hong_Kong Asia/Tokyo Australia/Sydney Pacific/umea Pacific/Fiji 22 May 25, 2015 HF

23 Time Zone Parameter Time Zone Configuration prop:vamitimezone=etc/utc May 25, 2015 HF 23

24 Time Zone Parameter 24 May 25, 2015 HF