package
0.0.0-20230926054540-a12d4bf8c8f4
Repository: https://github.com/odim-project/pluginciscoaci.git
Documentation: pkg.go.dev

# README

REDFISH PLUGIN CONFIG VARIABLES

VariablesTypeSubcategorySubcategory TypeDescription
RootServiceUUIDstringStatic uuid used for plugin root service
PluginConfIDstringIdentifier used by ODIMRA for identifying the plugin
PluginConfHoststringplugin host address for ODIMRA to contact plugin
PluginConfPortstringplugin port for ODIMRA to contact plugin
PluginConfUserNamestringplugin user name for ODIMRA to interact with plugin
PluginConfPasswordstringplugin password for ODIMRA to interact with plugin
EventConfDestinationURIstringURI that will be posted on the resource as destination for events
EventConfListenerHoststringHost address that will be posted on the resource as destination for events
EventConfListenerPortstringHost address port that will be posted on the resource as destination for events
KeyCertConRootCACertificatePathstringTLS root certificate
KeyCertConPrivateKeyPathstringPlugin private key path for ODIMRA and plugin interaction
KeyCertConCertificatePathstringPlugin certificate path for ODIMRA and plugin interaction
FirmwareVersionstringversion information of the plugin
SessionTimeoutInMinutesintegerPlugin session time out in minutes
LoadBalancerConfLBHoststringLoad Balancer host address for plugin
LoadBalancerConfLBPortstringLoad Balancer host address port for plugin
MessageBusConfMessageQueueConfigFilePathstring
MessageBusConfMessageBusTypestringThis holds information Event Message Bus Type
MessageBusConfMessageBusQueuelist of stringsThis holds name of all message bus Queues
URLTranslationcollectionThis holds the north bound and south bound urls
URLTranslationNorthBoundURL.ODIMcollection of stringsThis the north bound urls
URLTranslationSouthBoundURL.redfishcollection of stringsThis holds the south bound urls
TLSConfMinVersionstringMinimum TLS version
TLSConfMaxVersionstringMaximum TLS version
TLSConfVerifyPeerbooleanIf server validation is required
TLSConfPreferredCipherSuiteslist of stringPreferred list of cipher suites

# Functions

GetPublicKey provides the public key configured in MockConfig.
GetRandomPort provides a random port between a range.
SetConfiguration will extract the config data from file.
SetUpMockConfig set ups a mock ration for unit testing.
ValidateConfiguration will validate configurations read and assign default values, where required.

# Constants

DefaultDBMinIdleConns - default MinIdleConns value.
DefaultDBPoolSize - default PoolSize value.
DefaultDBProtocol - default Protocol value.

# Variables

AllowedMessageBusTypes is for checking for message types are allowed.
Data will have the configuration data from config file.

# Structs

APICConf is for holding all the cisco APIC related configurations.
DBConf holds all DB related configurations.
EventConf is for holding all events related configuration.
KeyCertConf is for holding all security oriented configuration.
LoadBalancerConf is for holding all load balancer related configurations.
MessageBusConf will have configuration data of MessageBusConf.
ODIMConf hold the value of the ODIMConfiguration to plugin.
PluginConf is for holding all the plugin related configurations.
TLSConf holds TLS confifurations used in https queries.
URLTranslation ...