ETSI Production Properties

• ETSI Production Properties, on page 1

ETSI Production PropertiesThere are many properties that can be set to determine the behaviour of ESC. These properties enable integrationof 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 aVNFM within the ETSI NFV MANO stack.

Table 1: ETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

StringThe host IP address onwhich the ETSIservice is located. Thisis a mandatoryproperty if the serverhas multiple IPaddresses, or if thedeployment isconfigured for HighAvailability (it shouldthen be set to the VIP).

server.host

falseBooleanWhere there aremultiple IP addresstypes assigned to theserver, use the IPv6address over any IPv4address.

server.host.preferInet6

ETSI Production Properties1

D e f a u l tValue

TypeDescriptionProperty Name

8250IntegerThe port used tocommunicate overHTTP.

server.port

8251IntegerThe port used tocommunicate overHTTPS.

server.port.https

trueBooleanDetermine whether tovalidate a host in anycertificate presentedwhen using HTTPS.Relaxes the validationof certificates,especially useful intesting.

certificate.validation

3IntegerThemaximumnumberof threads utilised forthe notificationservice.

notification.maxThreads

trueBooleanUpon creating a news u b s c r i p t i o n ,determine whether totest

notification.subscription.test

httpsEnumThe HTTP schemeu s e d f o rcommunicating withthe NFVO fornotifications. Thevalid values are httpand https.

notification.links.httpScheme

5IntegerThe number of retriesfor the notificationretry mechanism.

notification.retry.maxAttempt

1000IntegerThe interval for thenotification retrymechanism.

notification.retry.backOff.delay

ETSI Production Properties2

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

StringMandatory: This isthe REST APIusername. It is set bysudo escadm etsi

set --rest_user

<username>:<password>

and should besynchronized here.

security.user.name

localhost:8280StringMandatory: TheapiRoot for theNFVO.

nfvo.apiRoot

httpEnumThe HTTP schemeu s e d f o rcommunicating withthe NFVO. The validvalues are http andhttps.

nfvo.httpScheme

trueBooleanDetermine if theVNFMwill attempt tosubscribe to packagenotifications.

nfvo.isPackageNotificationSupported

httpsEnumThe HTTP schemeu s e d f o rcommunicating withthe NFVO whenpolling for responses.The valid values arehttp and https.

nfvo.callback.httpScheme

StringThe username forNFVO credentials.

nfvo.userName

StringThe password forNFVO credentials,required in plain text.

nfvo.password

1000IntegerThe number of retriesfor the exponentialretry mechanism.

retryTemplate.expotential.retryPolicy.maxAttempt

1000IntegerThe starting intervalfor the exponentialretry mechanism.

retryTemplate.expotential.backOffPolicy.interval.initial

ETSI Production Properties3

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

50IntegerThe number of retriesfor the simple retrymechanism.

retry.simple.maxAttempt

1000IntegerThe interval for thes im p l e r e t r ymechanism.

retry.simple.backOff.delay

StringThe value to use tofilter packages on theNFVOwhen queryingfor packages.

nfvo.allPackagesFilter

usernameStringProvide an alternateattribute name whenspecifying theu s e r n am e i naccessInfo.

mapping.vimConnectionInfo.accessInfo.username

passwordStringProvide an alternateattribute name whenspecifying thep a s s w o r d i naccessInfo.

mapping.vimConnectionInfo.accessInfo.password

projectStringProvide an alternateattribute name whenspecifying the projectin accessInfo.

mapping.vimConnectionInfo.accessInfo.project

projectDomainStringProvide an alternateattribute name whenspecifying theprojectDomain inaccessInfo.

mapping.vimConnectionInfo.accessInfo.projectDomain

userDomainStringProvide an alternateattribute name whenspecifying theuserDomain inaccessInfo.

mapping.vimConnectionInfo.accessInfo.userDomain

vim_projectStringProvide an alternateattribute name whenspecifying thevim_project inaccessInfo.

mapping.vimConnectionInfo.accessInfo.vim_project

ETSI Production Properties4

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

vim_vdcStringProvide an alternateattribute name whenspecifying thevim_vdc in accessInfo.

mapping.vimConnectionInfo.accessInfo.vim_vdc

5IntegerThe number of retriesf o r f a i l e dG r a n t R e q u e s tattempts.

nfvo.grantRequest.retry.maxAttempt

1000IntegerThe interval for theretries for failedG r a n t R e q u e s tattempts.

nfvo.grantRequest.retry.backOff.delay

yyyy-MM-dd

'T'HH:mm:ss.

SSSXXX

StringA string to represent adate format to allowfor varying NFVOimplementations toread dates correctly.

spring.jackson.date-format

StringS e t t i n g t h eauthentication type ofthe NFVO that isbeing used. Requiredproperty. Validoptions are "BASIC","OAUTH2", "OFF".All other Strings willbe treated the same as"OFF". Use this toenable Basic andO A u t h 2authentication.

nfvo.authenticationType

StringFor NFVO OAuth2Authentication. ClientID.

nfvo.clientID

StringFor NFVO OAuth2Authentication. ClientSecret.

nfvo.clientSecret

StringFor NFVO OAuth2Authentication. Theendpoint for ETSI toretrieve a OAuth2token from the NFVO.

nfvo.tokenEndpoint

ETSI Production Properties5

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

IntegerSet the bucket capacityfor read (GET)requeusts to the ETSIREST API.

By default this isdisabled.

rate.limit.capacity.read

DoubleSets the rate (persecond) at which thebucket empties for theread (GET) requests tothe ETSI REST API.

By default this isdisabled.

rate.limit.perSecond.read

IntegerSet the bucket capacityfor write (POST, PUT,PATCH, DELETE)requeusts to the ETSIREST API.

By default this isdisabled.

rate.limit.capacity.write

DoubleSets the rate (persecond) at which thebucket empties for thewrite (POST, PUT,PATCH, DELETE)requests to the ETSIREST API.

By default this isdisabled.

rate.limit.perSecond.write

falseBooleanThe flag to enablelogging response forquery multiple VNFinstances and responsefor query multipleVNF lifecyclemanagement operationoccurrences.

log.multiple.query

ETSI Production Properties6

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

1IntegerSet the interval valuefor theVnfLcmOpOcccleanup task.

The combination ofinterval.value andinterval.unit willdetermine thefrequency that thecleanup task isexecuted.

scheduled.cleanup[vnfLcmOpOcc].interval.value

DAYSSet the interval unitfor theVnfLcmOpOcccleanup task.

The combination ofinterval.value andinterval.unit willdetermine thefrequency that thecleanup task isexecuted.

Valid values:

NANOS, MICROS,

MILLIS, SECONDS,

MINUTES, HOURS,

HALF_DAYS, DAYS

scheduled.cleanup[vnfLcmOpOcc].interval.unit

60IntegerSet the age value forthe VnfLcmOpOcccleanup task.

The combination ofage.value and age.unitwill determine the ageof orphan records tobe deleted.

scheduled.cleanup[vnfLcmOpOcc].age.value

ETSI Production Properties7

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

DAYSSet the age unit for theV n f L c m O p O c ccleanup task.

The combination ofage.value and age.unitwill determine the ageof orphan records tobe deleted.

Valid values:

NANOS, MICROS,

MILLIS, SECONDS,

MINUTES, HOURS,

HALF_DAYS, DAYS

scheduled.cleanup[vnfLcmOpOcc].age.unit

0IntegerSetting a value > 0turns on paging forquery endpoints.

This value representsthe number of resultsto be included perpage.

If a response is pagedand there are furtherpages then theresponse will includea header named "Link"with rel="next" forexample:

<http://example.com

/resources?nextpage_

opaque_marker=abc123>;rel="next"

The link url willretrieve the next page.

If there are no furtherpages to be retrievedthen the Link headerwill be omitted.

paging.size

ETSI Production Properties8

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

falseBooleanSetting the value totrue will change thebehaviour of ETSIquery endpoints toreturn the full set ofattributes if anattribute selector is notprovided (all_fields).

attribute.selector.default.all_fields

falseBooleanDefines whether thelifecycle operationwill move to terminalstate automatically one r r o r d u r i n gmonitoring migration.

monitorMigration.terminalStateOnError

falseBooleanAllows the operationsENABLE/DISABLEMONITOR to bep e r f o r m e dsynchronously. Note:This is only supportedin a non cloud nativeenvironment.

sync.supported

MONITORING_

MIGRATION

MONITORING_

OPERATION

Part of the propertiesused to register thei n f r a s t r u c t u r enotifications. Definesthe operation typesfilter.

I f t h e s eproperties areset, theninfrastructurenotificationswill not besent to theo t h e rsubscriptions.

Note

subscription.notifications.infra.

filter.operationTypes

ETSI Production Properties9

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

STARTING

PROCESSING

COMPLETED

FAILED_TEMP

FAILED

ROLLING_BACK

ROLLED_BACK

Part of the propertiesused to register thei n f r a s t r u c t u r enotifications.

Defines the operationstates filter.

I f t h e s eproperties areset, theninfrastructurenotificationswill not besent to theo t h e rsubscriptions.

Note

subscription.notifications.infra.

filter.operationStates

StringPart of the propertiesused to register thei n f r a s t r u c t u r enotifications.

Defines the callbackURI to send thenotifications. This isthe full URI includingthe scheme, host andport.

I f t h e s eproperties areset, theninfrastructurenotificationswill not besent to theo t h e rsubscriptions.

Note

subscription.notifications.infra.

callbackUri

ETSI Production Properties10

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

BASIC

OAUTH2_CLIENT_

CREDENTIALS

Part of the propertiesused to register thei n f r a s t r u c t u r enotifications.

D e f i n e s t h eauthentication type forthe notification.

I f t h e s eproperties areset, theninfrastructurenotificationswill not besent to theo t h e rsubscriptions.

Note

subscription.notifications.infra.

authentication.authType

StringPart of the propertiesused to register thei n f r a s t r u c t u r enotifications.

Defines the BASICauthType username.

I f t h e s eproperties areset, theninfrastructurenotificationswill not besent to theo t h e rsubscriptions.

Note

subscription.notifications.infra.

authentication.paramsBasic.userName

ETSI Production Properties11

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

StringPart of the propertiesused to register thei n f r a s t r u c t u r enotifications.

Defines the BASICauthType password.

I f t h e s eproperties areset, theninfrastructurenotificationswill not besent to theo t h e rsubscriptions.

Note

subscription.notifications.infra.

authentication.paramsBasic.password

StringPart of the propertiesused to register thei n f r a s t r u c t u r enotifications.

D e f i n e s t h eOAUTH2_CLIENT_CREDENTIALS

authType client id.

I f t h e s eproperties areset, theninfrastructurenotificationswill not besent to theo t h e rsubscriptions.

Note

subscription.notifications.infra.

authentication.paramsOauth2ClientCredentials.

clientId

ETSI Production Properties12

ETSI Production PropertiesETSI Production Properties

D e f a u l tValue

TypeDescriptionProperty Name

StringPart of the propertiesused to register thei n f r a s t r u c t u r enotifications.

D e f i n e s t h eOAUTH2_CLIENT_CREDENTIALS

authType clientpassword.

I f t h e s eproperties areset, theninfrastructurenotificationswill not besent to theo t h e rsubscriptions.

Note

subscription.notifications.infra.authentication.

paramsOauth2ClientCredentials.clientPassword

StringPart of the propertiesused to register thei n f r a s t r u c t u r enotifications.

D e f i n e s t h eOAUTH2_CLIENT_

C R E D E N T I A L S

authType tokenendpoint. This is thefull URI including thescheme, host and port.

I f t h e s eproperties areset, theninfrastructurenotificationswill not besent to theo t h e rsubscriptions.

Note

subscription.notifications.infra.

authentication.paramsOauth2ClientCredentials.

tokenEndpoint

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

ETSI Production Properties13

ETSI Production PropertiesETSI Production Properties

ETSI Production Properties14

ETSI Production PropertiesETSI Production Properties