netconf

package
v0.0.0-...-50def94 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 2, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

NETCONF Protocol Data Types and Protocol Operations.

Copyright (c) 2011 IETF Trust and the persons identified as the document authors. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info).

This version of this YANG module is part of RFC 6241; see the RFC itself for full legal notices.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CancelCommit 

type CancelCommit struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input CancelCommit_Input
}

CancelCommit This operation is used to cancel an ongoing confirmed commit. If the confirmed commit is persistent, the parameter 'persist-id' must be given, and it must match the value of the 'persist' parameter.

func (*CancelCommit) GetEntityData 

func (cancelCommit *CancelCommit) GetEntityData() *types.CommonEntityData

type CancelCommit_Input 

type CancelCommit_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// This parameter is given in order to cancel a persistent confirmed commit.
	// The value must be equal to the value given in the 'persist' parameter to
	// the <commit> operation. If it does not match, the operation fails with an
	// 'invalid-value' error. The type is string.
	PersistId interface{}
}

CancelCommit_Input

func (*CancelCommit_Input) GetEntityData 

func (input *CancelCommit_Input) GetEntityData() *types.CommonEntityData

type CloseSession 

type CloseSession struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
}

CloseSession Request graceful termination of a NETCONF session.

func (*CloseSession) GetEntityData 

func (closeSession *CloseSession) GetEntityData() *types.CommonEntityData

type Commit 

type Commit struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input Commit_Input
}

Commit Commit the candidate configuration as the device's new current configuration.

func (*Commit) GetEntityData 

func (commit *Commit) GetEntityData() *types.CommonEntityData

type Commit_Input 

type Commit_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Requests a confirmed commit. The type is interface{}.
	Confirmed interface{}

	// The timeout interval for a confirmed commit. The type is interface{} with
	// range: 1..4294967295. Units are seconds. The default value is 600.
	ConfirmTimeout interface{}

	// This parameter is used to make a confirmed commit persistent.  A persistent
	// confirmed commit is not aborted if the NETCONF session terminates.  The
	// only way to abort a persistent confirmed commit is to let the timer expire,
	// or to use the <cancel-commit> operation.  The value of this parameter is a
	// token that must be given in the 'persist-id' parameter of <commit> or
	// <cancel-commit> operations in order to confirm or cancel the persistent
	// confirmed commit.  The token should be a random string. The type is string.
	Persist interface{}

	// This parameter is given in order to commit a persistent confirmed commit.
	// The value must be equal to the value given in the 'persist' parameter to
	// the <commit> operation. If it does not match, the operation fails with an
	// 'invalid-value' error. The type is string.
	PersistId interface{}
}

Commit_Input

func (*Commit_Input) GetEntityData 

func (input *Commit_Input) GetEntityData() *types.CommonEntityData

type CopyConfig 

type CopyConfig struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input CopyConfig_Input
}

CopyConfig Create or replace an entire configuration datastore with the contents of another complete configuration datastore.

func (*CopyConfig) GetEntityData 

func (copyConfig *CopyConfig) GetEntityData() *types.CommonEntityData

type CopyConfig_Input 

type CopyConfig_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The explicit defaults processing mode requested. The type is
	// WithDefaultsMode.
	WithDefaults interface{}

	// Particular configuration to copy to.
	Target CopyConfig_Input_Target

	// Particular configuration to copy from.
	Source CopyConfig_Input_Source
}

CopyConfig_Input

func (*CopyConfig_Input) GetEntityData 

func (input *CopyConfig_Input) GetEntityData() *types.CommonEntityData

type CopyConfig_Input_Source 

type CopyConfig_Input_Source struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The candidate configuration is the config source. The type is interface{}.
	Candidate interface{}

	// The running configuration is the config source. The type is interface{}.
	Running interface{}

	// The startup configuration is the config source. The type is interface{}.
	Startup interface{}

	// The URL-based configuration is the config source. The type is string.
	Url interface{}

	// Inline Config content: <config> element.  Represents an entire
	// configuration datastore, not a subset of the running datastore. The type is
	// string.
	Config interface{}
}

CopyConfig_Input_Source Particular configuration to copy from.

func (*CopyConfig_Input_Source) GetEntityData 

func (source *CopyConfig_Input_Source) GetEntityData() *types.CommonEntityData

type CopyConfig_Input_Target 

type CopyConfig_Input_Target struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The candidate configuration is the config target. The type is interface{}.
	Candidate interface{}

	// The running configuration is the config target. This is
	// optional-to-implement on the server. The type is interface{}.
	Running interface{}

	// The startup configuration is the config target. The type is interface{}.
	Startup interface{}

	// The URL-based configuration is the config target. The type is string.
	Url interface{}
}

CopyConfig_Input_Target Particular configuration to copy to.

func (*CopyConfig_Input_Target) GetEntityData 

func (target *CopyConfig_Input_Target) GetEntityData() *types.CommonEntityData

type DeleteConfig 

type DeleteConfig struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input DeleteConfig_Input
}

DeleteConfig Delete a configuration datastore.

func (*DeleteConfig) GetEntityData 

func (deleteConfig *DeleteConfig) GetEntityData() *types.CommonEntityData

type DeleteConfig_Input 

type DeleteConfig_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Particular configuration to delete.
	Target DeleteConfig_Input_Target
}

DeleteConfig_Input

func (*DeleteConfig_Input) GetEntityData 

func (input *DeleteConfig_Input) GetEntityData() *types.CommonEntityData

type DeleteConfig_Input_Target 

type DeleteConfig_Input_Target struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The startup configuration is the config target. The type is interface{}.
	Startup interface{}

	// The URL-based configuration is the config target. The type is string.
	Url interface{}
}

DeleteConfig_Input_Target Particular configuration to delete.

func (*DeleteConfig_Input_Target) GetEntityData 

func (target *DeleteConfig_Input_Target) GetEntityData() *types.CommonEntityData

type DiscardChanges 

type DiscardChanges struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
}

DiscardChanges Revert the candidate configuration to the current running configuration.

func (*DiscardChanges) GetEntityData 

func (discardChanges *DiscardChanges) GetEntityData() *types.CommonEntityData

type EditConfig 

type EditConfig struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input EditConfig_Input
}

EditConfig The <edit-config> operation loads all or part of a specified configuration to the specified target configuration.

func (*EditConfig) GetEntityData 

func (editConfig *EditConfig) GetEntityData() *types.CommonEntityData

type EditConfig_Input 

type EditConfig_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The default operation to use. The type is DefaultOperation. The default
	// value is merge.
	DefaultOperation interface{}

	// The test option to use. The type is TestOption. The default value is
	// test-then-set.
	TestOption interface{}

	// The error option to use. The type is ErrorOption. The default value is
	// stop-on-error.
	ErrorOption interface{}

	// Inline Config content. The type is string.
	Config interface{}

	// URL-based config content. The type is string.
	Url interface{}

	// Particular configuration to edit.
	Target EditConfig_Input_Target
}

EditConfig_Input

func (*EditConfig_Input) GetEntityData 

func (input *EditConfig_Input) GetEntityData() *types.CommonEntityData

type EditConfig_Input_DefaultOperation 

type EditConfig_Input_DefaultOperation string

EditConfig_Input_DefaultOperation represents The default operation to use. 

const (
	// The default operation is merge.
	EditConfig_Input_DefaultOperation_merge EditConfig_Input_DefaultOperation = "merge"

	// The default operation is replace.
	EditConfig_Input_DefaultOperation_replace EditConfig_Input_DefaultOperation = "replace"

	// There is no default operation.
	EditConfig_Input_DefaultOperation_none EditConfig_Input_DefaultOperation = "none"
)

type EditConfig_Input_ErrorOption 

type EditConfig_Input_ErrorOption string

EditConfig_Input_ErrorOption represents The error option to use. 

const (
	// The server will stop on errors.
	EditConfig_Input_ErrorOption_stop_on_error EditConfig_Input_ErrorOption = "stop-on-error"

	// The server may continue on errors.
	EditConfig_Input_ErrorOption_continue_on_error EditConfig_Input_ErrorOption = "continue-on-error"

	// The server will roll back on errors.
	// This value can only be used if the 'rollback-on-error'
	// feature is supported.
	EditConfig_Input_ErrorOption_rollback_on_error EditConfig_Input_ErrorOption = "rollback-on-error"
)

type EditConfig_Input_Target 

type EditConfig_Input_Target struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The candidate configuration is the config target. The type is interface{}.
	Candidate interface{}

	// The running configuration is the config source. The type is interface{}.
	Running interface{}
}

EditConfig_Input_Target Particular configuration to edit.

func (*EditConfig_Input_Target) GetEntityData 

func (target *EditConfig_Input_Target) GetEntityData() *types.CommonEntityData

type EditConfig_Input_TestOption 

type EditConfig_Input_TestOption string

EditConfig_Input_TestOption represents The test option to use. 

const (
	// The server will test and then set if no errors.
	EditConfig_Input_TestOption_test_then_set EditConfig_Input_TestOption = "test-then-set"

	// The server will set without a test first.
	EditConfig_Input_TestOption_set EditConfig_Input_TestOption = "set"

	// The server will only test and not set, even
	// if there are no errors.
	EditConfig_Input_TestOption_test_only EditConfig_Input_TestOption = "test-only"
)

type EditOperationType 

type EditOperationType string

EditOperationType represents NETCONF 'operation' attribute values 

const (
	// The configuration data identified by the
	// element containing this attribute is merged
	// with the configuration at the corresponding
	// level in the configuration datastore identified
	// by the target parameter.
	EditOperationType_merge EditOperationType = "merge"

	// The configuration data identified by the element
	// containing this attribute replaces any related
	// configuration in the configuration datastore
	// identified by the target parameter.  If no such
	// configuration data exists in the configuration
	// datastore, it is created.  Unlike a
	// <copy-config> operation, which replaces the
	// entire target configuration, only the configuration
	// actually present in the config parameter is affected.
	EditOperationType_replace EditOperationType = "replace"

	// The configuration data identified by the element
	// containing this attribute is added to the
	// configuration if and only if the configuration
	// data does not already exist in the configuration
	// datastore.  If the configuration data exists, an
	// <rpc-error> element is returned with an
	// <error-tag> value of 'data-exists'.
	EditOperationType_create EditOperationType = "create"

	// The configuration data identified by the element
	// containing this attribute is deleted from the
	// configuration if and only if the configuration
	// data currently exists in the configuration
	// datastore.  If the configuration data does not
	// exist, an <rpc-error> element is returned with
	// an <error-tag> value of 'data-missing'.
	EditOperationType_delete_ EditOperationType = "delete"

	// The configuration data identified by the element
	// containing this attribute is deleted from the
	// configuration if the configuration
	// data currently exists in the configuration
	// datastore.  If the configuration data does not
	// exist, the 'remove' operation is silently ignored
	// by the server.
	EditOperationType_remove EditOperationType = "remove"
)

type ErrorSeverityType 

type ErrorSeverityType string

ErrorSeverityType represents NETCONF Error Severity 

const (
	// Error severity
	ErrorSeverityType_error_ ErrorSeverityType = "error"

	// Warning severity
	ErrorSeverityType_warning ErrorSeverityType = "warning"
)

type ErrorTagType 

type ErrorTagType string

ErrorTagType represents NETCONF Error Tag 

const (
	// The request requires a resource that
	// already is in use.
	ErrorTagType_in_use ErrorTagType = "in-use"

	// The request specifies an unacceptable value for one
	// or more parameters.
	ErrorTagType_invalid_value ErrorTagType = "invalid-value"

	// The request or response (that would be generated) is
	// too large for the implementation to handle.
	ErrorTagType_too_big ErrorTagType = "too-big"

	// An expected attribute is missing.
	ErrorTagType_missing_attribute ErrorTagType = "missing-attribute"

	// An attribute value is not correct; e.g., wrong type,
	// out of range, pattern mismatch.
	ErrorTagType_bad_attribute ErrorTagType = "bad-attribute"

	// An unexpected attribute is present.
	ErrorTagType_unknown_attribute ErrorTagType = "unknown-attribute"

	// An expected element is missing.
	ErrorTagType_missing_element ErrorTagType = "missing-element"

	// An element value is not correct; e.g., wrong type,
	// out of range, pattern mismatch.
	ErrorTagType_bad_element ErrorTagType = "bad-element"

	// An unexpected element is present.
	ErrorTagType_unknown_element ErrorTagType = "unknown-element"

	// An unexpected namespace is present.
	ErrorTagType_unknown_namespace ErrorTagType = "unknown-namespace"

	// Access to the requested protocol operation or
	// data model is denied because authorization failed.
	ErrorTagType_access_denied ErrorTagType = "access-denied"

	// Access to the requested lock is denied because the
	// lock is currently held by another entity.
	ErrorTagType_lock_denied ErrorTagType = "lock-denied"

	// Request could not be completed because of
	// insufficient resources.
	ErrorTagType_resource_denied ErrorTagType = "resource-denied"

	// Request to roll back some configuration change (via
	// rollback-on-error or <discard-changes> operations)
	// was not completed for some reason.
	ErrorTagType_rollback_failed ErrorTagType = "rollback-failed"

	// Request could not be completed because the relevant
	// data model content already exists.  For example,
	// a 'create' operation was attempted on data that
	// already exists.
	ErrorTagType_data_exists ErrorTagType = "data-exists"

	// Request could not be completed because the relevant
	// data model content does not exist.  For example,
	// a 'delete' operation was attempted on
	// data that does not exist.
	ErrorTagType_data_missing ErrorTagType = "data-missing"

	// Request could not be completed because the requested
	// operation is not supported by this implementation.
	ErrorTagType_operation_not_supported ErrorTagType = "operation-not-supported"

	// Request could not be completed because the requested
	// operation failed for some reason not covered by
	// any other error condition.
	ErrorTagType_operation_failed ErrorTagType = "operation-failed"

	// This error-tag is obsolete, and SHOULD NOT be sent
	// by servers conforming to this document.
	ErrorTagType_partial_operation ErrorTagType = "partial-operation"

	// A message could not be handled because it failed to
	// be parsed correctly.  For example, the message is not
	// well-formed XML or it uses an invalid character set.
	ErrorTagType_malformed_message ErrorTagType = "malformed-message"
)

type Get 

type Get struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input Get_Input

	Output Get_Output
}

Get Retrieve running configuration and device state information.

func (*Get) GetEntityData 

func (get *Get) GetEntityData() *types.CommonEntityData

type GetConfig 

type GetConfig struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input GetConfig_Input

	Output GetConfig_Output
}

GetConfig Retrieve all or part of a specified configuration.

func (*GetConfig) GetEntityData 

func (getConfig *GetConfig) GetEntityData() *types.CommonEntityData

type GetConfig_Input 

type GetConfig_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Subtree or XPath filter to use. The type is string.
	Filter interface{}

	// The explicit defaults processing mode requested. The type is
	// WithDefaultsMode.
	WithDefaults interface{}

	// Particular configuration to retrieve.
	Source GetConfig_Input_Source
}

GetConfig_Input

func (*GetConfig_Input) GetEntityData 

func (input *GetConfig_Input) GetEntityData() *types.CommonEntityData

type GetConfig_Input_Source 

type GetConfig_Input_Source struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The candidate configuration is the config source. The type is interface{}.
	Candidate interface{}

	// The running configuration is the config source. The type is interface{}.
	Running interface{}

	// The startup configuration is the config source. This is
	// optional-to-implement on the server because not all servers will support
	// filtering for this datastore. The type is interface{}.
	Startup interface{}
}

GetConfig_Input_Source Particular configuration to retrieve.

func (*GetConfig_Input_Source) GetEntityData 

func (source *GetConfig_Input_Source) GetEntityData() *types.CommonEntityData

type GetConfig_Output 

type GetConfig_Output struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Copy of the source datastore subset that matched the filter criteria (if
	// any).  An empty data container indicates that the request did not produce
	// any results. The type is string.
	Data interface{}
}

GetConfig_Output

func (*GetConfig_Output) GetEntityData 

func (output *GetConfig_Output) GetEntityData() *types.CommonEntityData

type Get_Input 

type Get_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// This parameter specifies the portion of the system configuration and state
	// data to retrieve. The type is string.
	Filter interface{}

	// The explicit defaults processing mode requested. The type is
	// WithDefaultsMode.
	WithDefaults interface{}
}

Get_Input

func (*Get_Input) GetEntityData 

func (input *Get_Input) GetEntityData() *types.CommonEntityData

type Get_Output 

type Get_Output struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Copy of the running datastore subset and/or state data that matched the
	// filter criteria (if any). An empty data container indicates that the
	// request did not produce any results. The type is string.
	Data interface{}
}

Get_Output

func (*Get_Output) GetEntityData 

func (output *Get_Output) GetEntityData() *types.CommonEntityData

type KillSession 

type KillSession struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input KillSession_Input
}

KillSession Force the termination of a NETCONF session.

func (*KillSession) GetEntityData 

func (killSession *KillSession) GetEntityData() *types.CommonEntityData

type KillSession_Input 

type KillSession_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Particular session to kill. The type is interface{} with range:
	// 1..4294967295. This attribute is mandatory.
	SessionId interface{}
}

KillSession_Input

func (*KillSession_Input) GetEntityData 

func (input *KillSession_Input) GetEntityData() *types.CommonEntityData

type Lock 

type Lock struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input Lock_Input
}

Lock The lock operation allows the client to lock the configuration system of a device.

func (*Lock) GetEntityData 

func (lock *Lock) GetEntityData() *types.CommonEntityData

type Lock_Input 

type Lock_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Particular configuration to lock.
	Target Lock_Input_Target
}

Lock_Input

func (*Lock_Input) GetEntityData 

func (input *Lock_Input) GetEntityData() *types.CommonEntityData

type Lock_Input_Target 

type Lock_Input_Target struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The candidate configuration is the config target. The type is interface{}.
	Candidate interface{}

	// The running configuration is the config target. The type is interface{}.
	Running interface{}

	// The startup configuration is the config target. The type is interface{}.
	Startup interface{}
}

Lock_Input_Target Particular configuration to lock.

func (*Lock_Input_Target) GetEntityData 

func (target *Lock_Input_Target) GetEntityData() *types.CommonEntityData

type Unlock 

type Unlock struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input Unlock_Input
}

Unlock The unlock operation is used to release a configuration lock, previously obtained with the 'lock' operation.

func (*Unlock) GetEntityData 

func (unlock *Unlock) GetEntityData() *types.CommonEntityData

type Unlock_Input 

type Unlock_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Particular configuration to unlock.
	Target Unlock_Input_Target
}

Unlock_Input

func (*Unlock_Input) GetEntityData 

func (input *Unlock_Input) GetEntityData() *types.CommonEntityData

type Unlock_Input_Target 

type Unlock_Input_Target struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The candidate configuration is the config target. The type is interface{}.
	Candidate interface{}

	// The running configuration is the config target. The type is interface{}.
	Running interface{}

	// The startup configuration is the config target. The type is interface{}.
	Startup interface{}
}

Unlock_Input_Target Particular configuration to unlock.

func (*Unlock_Input_Target) GetEntityData 

func (target *Unlock_Input_Target) GetEntityData() *types.CommonEntityData

type Validate 

type Validate struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	Input Validate_Input
}

Validate Validates the contents of the specified configuration.

func (*Validate) GetEntityData 

func (validate *Validate) GetEntityData() *types.CommonEntityData

type Validate_Input 

type Validate_Input struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Particular configuration to validate.
	Source Validate_Input_Source
}

Validate_Input

func (*Validate_Input) GetEntityData 

func (input *Validate_Input) GetEntityData() *types.CommonEntityData

type Validate_Input_Source 

type Validate_Input_Source struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The candidate configuration is the config source. The type is interface{}.
	Candidate interface{}

	// The running configuration is the config source. The type is interface{}.
	Running interface{}

	// The startup configuration is the config source. The type is interface{}.
	Startup interface{}

	// The URL-based configuration is the config source. The type is string.
	Url interface{}

	// Inline Config content: <config> element.  Represents an entire
	// configuration datastore, not a subset of the running datastore. The type is
	// string.
	Config interface{}
}

Validate_Input_Source Particular configuration to validate.

func (*Validate_Input_Source) GetEntityData 

func (source *Validate_Input_Source) GetEntityData() *types.CommonEntityData

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.