cisco_ftp_client_mib

Documentation

Overview

The MIB module for invoking Internet File Transfer Protocol (FTP) operations for network management purposes.

Index

• type CISCOFTPCLIENTMIB
  • func (cISCOFTPCLIENTMIB *CISCOFTPCLIENTMIB) GetEntityData() *types.CommonEntityData
• type CISCOFTPCLIENTMIB_CfcRequest
  • func (cfcRequest *CISCOFTPCLIENTMIB_CfcRequest) GetEntityData() *types.CommonEntityData
• type CISCOFTPCLIENTMIB_CfcRequestTable
  • func (cfcRequestTable *CISCOFTPCLIENTMIB_CfcRequestTable) GetEntityData() *types.CommonEntityData
• type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry
  • func (cfcRequestEntry *CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry) GetEntityData() *types.CommonEntityData
• type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperation
• type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState
• type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult
• type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestStop

Types

type CISCOFTPCLIENTMIB

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

	CfcRequest CISCOFTPCLIENTMIB_CfcRequest

	// A table of FTP client requests.
	CfcRequestTable CISCOFTPCLIENTMIB_CfcRequestTable
}

CISCOFTPCLIENTMIB

func (*CISCOFTPCLIENTMIB) GetEntityData

func (cISCOFTPCLIENTMIB *CISCOFTPCLIENTMIB) GetEntityData() *types.CommonEntityData

type CISCOFTPCLIENTMIB_CfcRequest

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

	// The maximum number of requests this system can hold in cfcRequestTable.  A
	// value of 0 indicates no configured limit.  This object may be read-only on
	// some systems.  When an attempt is made to create a new entry but the table
	// is full, the oldest completed entry is bumped out and cfcRequestsBumped is
	// incremented.  Changing this number does not disturb existing requests that
	// are not completed and bumps completed requests as necessary. The type is
	// interface{} with range: 0..4294967295.
	CfcRequestMaximum interface{}

	// The current number of requests in cfcRequestTable. The type is interface{}
	// with range: 0..4294967295.
	CfcRequests interface{}

	// The highest number of requests in cfcRequestTable since this system was
	// last initialized. The type is interface{} with range: 0..4294967295.
	CfcRequestsHigh interface{}

	// The number of requests in cfcRequestTable that were bumped out to make room
	// for a new request. The type is interface{} with range: 0..4294967295.
	CfcRequestsBumped interface{}
}

CISCOFTPCLIENTMIB_CfcRequest

func (*CISCOFTPCLIENTMIB_CfcRequest) GetEntityData

func (cfcRequest *CISCOFTPCLIENTMIB_CfcRequest) GetEntityData() *types.CommonEntityData

type CISCOFTPCLIENTMIB_CfcRequestTable

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

	// Information about an FTP client request.  Management applications use
	// cfcRequestEntryStatus to control entry modification, creation, and
	// deletion.  Setting cfcRequestEntryStatus to 'active' from any state
	// including 'active' causes the operation to be started.  The entry may be
	// modified only when cfcRequestOperationState is 'stopped'.  The value of
	// cfcRequestEntryStatus may be set to 'destroy' at any time.  Doing so will
	// abort a running request.  Entries may not be created without explicitly
	// setting cfcRequestEntryStatus to either 'createAndGo' or 'createAndWait'.
	// The type is slice of CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry.
	CfcRequestEntry []*CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry
}

CISCOFTPCLIENTMIB_CfcRequestTable A table of FTP client requests.

func (*CISCOFTPCLIENTMIB_CfcRequestTable) GetEntityData

func (cfcRequestTable *CISCOFTPCLIENTMIB_CfcRequestTable) GetEntityData() *types.CommonEntityData

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. An arbitrary integer to uniquely identify this
	// entry.  To create an entry a management application should pick a random
	// number. The type is interface{} with range: 1..4294967295.
	CfcRequestIndex interface{}

	// The FTP operation to be performed. The type is CfcRequestOperation.
	CfcRequestOperation interface{}

	// The local file on which the operation is to be performed. The type is
	// string with length: 1..255.
	CfcRequestLocalFile interface{}

	// The remote file on which the operation is to be performed. The type is
	// string with length: 1..255.
	CfcRequestRemoteFile interface{}

	// The domain name or IP address of the FTP server to use. The type is string
	// with length: 1..64.
	CfcRequestServer interface{}

	// The user name to use at the FTP server. The type is string with length:
	// 1..32.
	CfcRequestUser interface{}

	// The password to use at the FTP server.  When read this object always
	// returns a zero-length string. The type is string with length: 0..16.
	CfcRequestPassword interface{}

	// The result of the FTP operation. The type is CfcRequestResult.
	CfcRequestResult interface{}

	// The value of sysUpTime when the operation completed.  For an incomplete
	// operation this value is zero. The type is interface{} with range:
	// 0..4294967295.
	CfcRequestCompletionTime interface{}

	// The action control to stop a running request.  Setting this to 'stop' will
	// begin the process of stopping the request.  Setting it to 'ready' or
	// setting it to 'stop' more than once have no effect.  When read this object
	// always returns ready. The type is CfcRequestStop.
	CfcRequestStop interface{}

	// The operational state of the file transfer.  To short-terminate the
	// transfer set cfcRequestStop to 'stop'. The type is
	// CfcRequestOperationState.
	CfcRequestOperationState interface{}

	// The control that allows modification, creation, and deletion of entries.
	// For detailed rules see the DESCRIPTION for cfcRequestEntry. The type is
	// RowStatus.
	CfcRequestEntryStatus interface{}
}

CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry Information about an FTP client request. Management applications use cfcRequestEntryStatus to control entry modification, creation, and deletion.

Setting cfcRequestEntryStatus to 'active' from any state including 'active' causes the operation to be started.

The entry may be modified only when cfcRequestOperationState is 'stopped'.

The value of cfcRequestEntryStatus may be set to 'destroy' at any time. Doing so will abort a running request.

Entries may not be created without explicitly setting cfcRequestEntryStatus to either 'createAndGo' or 'createAndWait'.

func (*CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry) GetEntityData

func (cfcRequestEntry *CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry) GetEntityData() *types.CommonEntityData

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperation

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperation string

CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperation represents The FTP operation to be performed.

const (
	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperation_putBinary CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperation = "putBinary"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperation_putASCII CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperation = "putASCII"
)

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState string

CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState represents the transfer set cfcRequestStop to 'stop'.

const (
	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState_running CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState = "running"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState_stopping CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState = "stopping"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState_stopped CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestOperationState = "stopped"
)

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult string

CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult represents The result of the FTP operation.

const (
	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_pending CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "pending"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_success CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "success"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_aborted CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "aborted"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_fileOpenFailLocal CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "fileOpenFailLocal"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_fileOpenFailRemote CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "fileOpenFailRemote"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_badDomainName CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "badDomainName"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_unreachableIpAddress CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "unreachableIpAddress"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_linkFailed CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "linkFailed"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_fileReadFailed CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "fileReadFailed"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult_fileWriteFailed CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestResult = "fileWriteFailed"
)

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestStop

type CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestStop string

CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestStop represents effect. When read this object always returns ready.

const (
	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestStop_ready CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestStop = "ready"

	CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestStop_stop CISCOFTPCLIENTMIB_CfcRequestTable_CfcRequestEntry_CfcRequestStop = "stop"
)