@node-net/netconf
@node-net/netconf: a NETCONF client for Node.js.
Import from @node-net/netconf in Node.js. It has everything in @node-net/netconf/core (the protocol, the client, the built-in device profiles and the connection interface) plus what needs Node.js: the SSH and TLS transports, call home, known_hosts, duplexConnection() for a Node stream of your own, and loading device profiles from files. Its connect() and withClient() and reconnecting() can also read YANG modules from directories.
Import from @node-net/netconf/core instead when the code must run outside Node.js, such as in a browser or a worker, over a transport you provide. See Outside Node.js.
Classes
- AbortError
- AuthenticationError
- CallHomeListener
- CapabilityError
- CapabilitySet
- CertificateError
- ClientContent
- ClientOps
- ConfigTransaction
- FrameDecoder
- FramingError
- HelloError
- HostKeyError
- LockDeniedError
- NetconfClient
- NetconfError
- PathError
- PendingCommit
- ProfileError
- ProtocolError
- Reconnecting
- RpcError
- SchemaUnavailableError
- Session
- SessionClosedError
- TimeoutError
- TransactionError
- TransportError
- XmlElement
- XmlError
- YangCache
- YangDataError
Interfaces
- Augment
- AuthenticationErrorOptions
- AutoDetect
- CallHomeCall
- CallHomeCaller
- CallHomeDevice
- CallHomeEvents
- CallHomeOptions
- CallHomeRemote
- CallHomeSshListen
- CallHomeTlsListen
- CandidateChangesOptions
- CandidateTx
- Capability
- ChannelHandler
- ChannelOptions
- CommitOptions
- CompareDatastoresOptions
- ConfigureOptions
- ConfigureStep
- ConfirmedCommitOptions
- ConfirmedTransaction
- Connection
- ConnectionPairOptions
- ConnectionPeer
- ConnectionReceiver
- ConnectOptions
- ContentJsonFormat
- ContentQuirks
- ContentXmlFormat
- CopyConfigOptions
- DataIssue
- DatastoreChange
- DeclaredFeature
- DecoderOptions
- DeviceMatch
- DeviceOps
- DeviceProfile
- DeviceProfileSpec
- DuplexConnectionOptions
- EditConfigOptions
- Extension
- ExtensionContext
- FormatOptions
- GetConfigOptions
- GetOptions
- HelloAdjustments
- HostKeyInfo
- HostKeyVerifier
- JsonFormat
- JsonOptions
- KeyboardInteractiveChallenge
- Logger
- MessageChannel
- ModuleCapability
- ModuleNamespaceInfo
- ModulesOptions
- ModuleSource
- ModuleText
- NamedPathTemplate
- NetconfErrorOptions
- Notification
- OperationDescriptor
- OperationRequest
- OperationSpec
- ParamDescriptor
- PathKey
- PathStep
- ProfileLoadOptions
- ProfileSource
- QualifiedAttrValue
- ReadOptions
- ReconnectingOptions
- ReconnectOptions
- RetryInfo
- RetryOptions
- RpcContext
- RpcErrorDetail
- RpcOptions
- RpcReply
- SerializeOptions
- ServerDatastore
- ServerDatastores
- ServerHello
- ServerModule
- ServerModules
- SessionEvents
- SessionMessage
- SessionOptions
- SessionQuirks
- SessionTimeouts
- SessionWarning
- SshAlgorithmEdit
- SshEndpoint
- SshOptions
- Timeouts
- TlsOptions
- ToJsonOptions
- ToObjectOptions
- ToXmlOptions
- TransactionOptions
- TransportInfo
- Workflow
- XmlAttribute
- XmlElementInit
- XmlFormat
- XmlObject
- XmlParseLimits
- XmlParseOptions
- XPathFilter
- YangOptions
- YangSettings
Type Aliases
- Attrs
- AttrValue
- AuthenticationReason
- BaseVersion
- CallHomeConnectOptions
- CallHomeTransport
- CapabilityCheck
- Child
- ConfigSource
- ConfigTarget
- ConnectionDefaults
- ConnectionFactory
- ContentMap
- Datastore
- DatastoreSource
- DeviceContext
- DeviceOperation
- EditOperation
- EditValue
- Filter
- FramingMode
- HostKeyPolicy
- InvokeInput
- InvokeOptions
- JsonDatastore
- KeyboardInteractiveHandler
- LogLevel
- NamespaceSource
- OperationParamType
- OpsMap
- Pem
- PendingCommitState
- ProfileParamType
- Quirks
- RequestArgs
- RequestBuilder
- RpcErrorSeverity
- RpcErrorTag
- RpcErrorType
- RpcGuard
- Secret
- SessionState
- SshAlgorithmLists
- SshAlgorithms
- SshJumpHost
- StandardErrorTag
- TimeoutPhase
- ToJson
- ToXml
- TransactionPhase
- TransactionTarget
- XmlNode
- XmlValue
- YangJsonObject
- YangJsonValue
Variables
- BASE_1_0
- BASE_1_1
- BASE_OPERATIONS
- BUILTIN_PROFILES_DIR
- CALL_HOME_SSH_PORT
- CALL_HOME_TLS_PORT
- CAPABILITY_PREFIX
- CONFIRM_MARGIN_MS
- DATASTORES_NS
- DEFAULT_CONFIRM_TIMEOUT
- DEFAULT_MAX_MESSAGE_BYTES
- DEFAULT_PARSE_LIMITS
- DEFAULT_SESSION_TIMEOUTS
- DEFAULT_SSH_ALGORITHMS
- DEFAULT_TIMEOUTS
- DEFAULT_TLS_CIPHERS
- INSECURE_ACCEPT_ANY
- LOG_LEVELS
- MAX_PARSE_DEPTH
- MONITORING_NS
- NETCONF_NS
- NMDA_NS
- NOTIFICATION_NS
- ORIGIN_NS
- QUIRK_NAMES
- READ_AS_XML_HINT
- RPC_CHANNEL
- WITH_DEFAULTS_NS
- XML_NS
- YANG_NS
Functions
- autoDetect
- buildOperation
- builtinDeviceProfiles
- compileNamedPath
- connect
- connectionPair
- defineDeviceProfile
- defineExtension
- duplexConnection
- fingerprintOf
- invoke
- joinConnections
- knownHosts
- knownHostsFile
- listenCallHome
- loadDeviceProfile
- loadDeviceProfiles
- lockHolder
- namedPath
- openChannel
- openSession
- parseCapability
- parsePath
- parseXml
- pathXPath
- reconnecting
- redactXml
- serializeXml
- sha256Fingerprint
- ssh
- subtree
- tls
- toObject
- toVerifier
- withCandidate
- withClient
- x
- xpath