Interface: CandidateTx
Defined in: netconf/src/operations/transaction.ts:170
What the callback gets: operations on the locked candidate.
Properties
sessionId
readonly sessionId: number;Defined in: netconf/src/operations/transaction.ts:172
The session the transaction runs on.
Methods
editConfig()
editConfig(options): Promise<RpcReply>;Defined in: netconf/src/operations/transaction.ts:178
<edit-config> on the candidate. config may be an RFC 7951 JSON object, converted with the candidate's YANG schema, when the transaction was started with a NetconfClient or an extension context.
Parameters
options
Omit<EditConfigOptions, "target"> & object & RpcOptions
Returns
Promise<RpcReply>
getCandidateChanges()
getCandidateChanges(options?): Promise<DatastoreChange[]>;Defined in: netconf/src/operations/transaction.ts:190
How the candidate differs from running, as client.content.getCandidateChanges() reports it: while the transaction holds its locks, exactly what the commit will apply. Needs the transaction to have been started with a NetconfClient; with a bare session or an extension context it rejects with a TypeError.
Parameters
options?
Returns
Promise<DatastoreChange[]>
getConfig()
getConfig(options?): Promise<XmlElement>;Defined in: netconf/src/operations/transaction.ts:180
<get-config> from the candidate, to see the edits so far. The filter may be an RFC 7951 JSON object, as for editConfig.
Parameters
options?
object & RpcOptions
Returns
Promise<XmlElement>
validate()
validate(options?): Promise<RpcReply>;Defined in: netconf/src/operations/transaction.ts:182
<validate> the candidate now (needs :validate).
Parameters
options?
Returns
Promise<RpcReply>