ETSI Production Properties

ETSI Production Properties

There are many properties that can be set to determine the behaviour of ESC. These properties enable integration of ESC with the NFVO in the system architecture.

You can access the properties file in the following location:

/opt/cisco/esc/esc_database/etsi-production.properties

The following table describes the parameters that can be used to control the behaviour of ESC acting as a VNFM within the ETSI NFV MANO stack.

Table 1. ETSI Production Properties

Property Name

Description

Type

Default Value

server.host

The host IP address on which the ETSI service is located. This is a mandatory property if the server has multiple IP addresses, or if the deployment is configured for High Availability (it should then be set to the VIP).

String

server.host.preferInet6

Where there are multiple IP address types assigned to the server, use the IPv6 address over any IPv4 address.

Boolean

false
server.port

The port used to communicate over HTTP.

Integer

8250
server.port.https

The port used to communicate over HTTPS.

Integer

8251
certificate.validation

Determine whether to validate a host in any certificate presented when using HTTPS. Allows for looser validation, especially useful in testing.

Boolean

true
notification.maxThreads

The maximum number of threads utilised for the notification service.

Integer

3
notification.subscription.test

Upon creating a new subscription, determine whether to test

Boolean

true
notification.links.httpScheme

The HTTP scheme used for communicating with the NFVO for notifications. Valid values: http, https.

Enum

https
notification.retry.maxAttempt

The number of retries for the notification retry mechanism.

Integer

5
notification.retry.backOff.delay

The interval for the notification retry mechanism.

Integer

1000
security.user.name

Mandatory. This is the REST API username. It is set by sudo escadm etsi set --rest_user <username>:<password> and should be synchronized here.

String

nfvo.apiRoot

Mandatory. The apiRoot for the NFVO.

String

localhost:8280
nfvo.httpScheme

The HTTP scheme used for communicating with the NFVO. Valid values: http, https.

Enum

http
nfvo.isPackageNotificationSupported

Determine if the VNFM will attempt to subscribe to package notifications.

Boolean

true
nfvo.callback.httpScheme

The HTTP scheme used for communicating with the NFVO when polling for responses. Valid values: http, https.

Enum

https
nfvo.username

The username for NFVO credentials.

String

nfvo.password

The password for NFVO credentials, required in plain text.

String

retryTemplate.expotential.retryPolicy.maxAttempt

The number of retries for the exponential retry mechanism.

Integer

1000
retryTemplate.expotential.backOffPolicy.interval.initial

The starting interval for the exponential retry mechanism.

Integer

1000
retry.simple.maxAttempt

The number of retries for the simple retry mechanism.

Integer

50
retry.simple.backOff.delay

The interval for the simple retry mechanism.

Integer

1000

nfvo.allPackagesFilter

The value to use to filter packages on the NFVO when querying for packages.

String

mapping.vimConnectionInfo.accessInfo.username

Provide an alternate attribute name when specifying the username in accessInfo.

String

username

mapping.vimConnectionInfo.accessInfo.password

Provide an alternate attribute name when specifying the password in accessInfo.

String

password

mapping.vimConnectionInfo.accessInfo.project

Provide an alternate attribute name when specifying the project in accessInfo.

String

project

mapping.vimConnectionInfo.accessInfo.projectDomain

Provide an alternate attribute name when specifying the projectDomain in accessInfo.

String

projectDomain

mapping.vimConnectionInfo.accessInfo.userDomain

Provide an alternate attribute name when specifying the userDomain in accessInfo.

String

userDomain

mapping.vimConnectionInfo.accessInfo.vim_project

Provide an alternate attribute name when specifying the vim_project in accessInfo.

String

vim_project

mapping.vimConnectionInfo.accessInfo.vim_vdc

Provide an alternate attribute name when specifying the vim_vdc in accessInfo.

String

vim_vdc

nfvo.grantRequest.retry.maxAttempt

The number of retries for failed GrantRequest attempts.

Integer

5

nfvo.grantRequest.retry.backOff.delay

The interval for the retries for failed GrantRequest attempts.

Integer

1000

spring.jackson.date-format A string to represent a date format to allow for varying NFVO implementations to read dates correctly. String yyyy-MM-dd'T'HH:mm:ss.SSSXXX

nfvo.authenticationType

Setting the authentication type of the NFVO that is being used. Optional property. Valid options are "BASIC", "OAUTH2", "OFF". All other Strings will be treated the same as "OFF". Use this to enable Basic and OAuth2 authentication.

String

nfvo.clientID

For NFVO OAuth2 Authentication. Client ID.

String

nfvo.clientSecret

For NFVO OAuth2 Authentication. Client Secret.

String

nfvo.tokenEndpoint

For NFVO OAuth2 Authentication. The endpoint for ETSI to retrieve a OAuth2 token from the NFVO.

String

rate.limit.capacity.read

Set the bucket capacity for read (GET) requeusts to the ETSI REST API.

By default this is disabled.

Integer

rate.limit.perSecond.read

Sets the rate (per second) at which the bucket empties for the read (GET) requests to the ETSI REST API.

By default this is disabled.

Double

rate.limit.capacity.write

Set the bucket capacity for write (POST, PUT, PATCH, DELETE) requeusts to the ETSI REST API.

By default this is disabled.

Integer

rate.limit.perSecond.write

Sets the rate (per second) at which the bucket empties for the write (POST, PUT, PATCH, DELETE) requests to the ETSI REST API.

By default this is disabled.

Double

For information on resource definitions, see Resource Definitions for ETSI API.