Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class file:ARemotePath (ABSTRACT)

Class ID:1673
Class Label: Remote Location
Encrypted: true - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin]
Read Access: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Remote location for data import or export.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: file:ARemoteHost,
Sub Mos: file:RemotePath, stats:DestP,
Relations To: fv:ATg, fv:AREpP,
Relations: file:RsARemoteHostToEpg, file:RsARemoteHostToEpp,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] pol:Obj Represents a generic policy object.
 
 		 ├
 		[V] pol:Comp Represents a policy component. This object is part of the policy definition.
 
 		 
 		 ├
 		[V] file:ARemoteHost Remote host with reachability information
 
 		 
 		 
 		 ├
 		[V] file:ARemotePath Remote location for data import or export.
 
 		 
 		 
 		 
 		 ├
 		[V] file:RemotePath The remote destination path parameters for the data export.
 
 		 
 		 
 		 
 		 ├
 		[V] stats:DestP The export policy. The export policy enables you to output statistics collection policy reports in an XML or JSON format. The reports are exported at a specified frequency and to a chosen export destination. Specifying the export destination can require selecting the protocol used when communicating with a remote server and entering a hostname/IP address, a remote path, the username and password the system should use to log in to the remote s...


Events


Faults


Fsms


Properties Summary
Defined in: file:ARemotePath
file:AuthenticationType
          scalar:Enum8 		authType  (file:ARemotePath:authType)
           The OSPF authentication type specifier. The type options are; default, md5, none, and simple.
string:CharBuffer identityPrivateKeyContents  (file:ARemotePath:identityPrivateKeyContents)
           NO COMMENTS
string:Basic identityPrivateKeyPassphrase  (file:ARemotePath:identityPrivateKeyPassphrase)
           Passphrase given at the identity key creation.
string:CharBuffer identityPublicKeyContents  (file:ARemotePath:identityPublicKeyContents)
           Certificate contents for data transfer. Used for credentials.
file:TransferProtocol
          scalar:Enum8 		protocol  (file:ARemotePath:protocol)
           Transfer prtocol to be used for data export
string:Basic remotePath  (file:ARemotePath:remotePath)
           Path where data will reside in the destination
address:PortNumber
          scalar:Uint16 		remotePort  (file:ARemotePath:remotePort)
           Remote port for data export destination
string:Basic uri  (file:ARemotePath:uri)
           Generated path
aaa:UserName
          string:Basic 		userName  (file:ARemotePath:userName)
           Username to be used to transfer data to destination
aaa:Key
          string:Password 		userPasswd  (file:ARemotePath:userPasswd)
           Password to be used to transfer data to destination
Defined in: file:ARemoteHost
reference:BinRef epgDn  (file:ARemoteHost:epgDn)
           Management EpG dn
address:HostNameOrDottedQuad
          string:Basic 		host  (file:ARemoteHost:host)
           Hostname or IP for export destination
l3:VrfName
          string:Basic 		vrfName  (file:ARemoteHost:vrfName)
           The vrf that remote host belongs to
Defined in: pol:Comp
naming:Descr
          string:Basic 		descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: pol:Obj
naming:Name
          string:Basic 		name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

authType

Type: file:AuthenticationType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The OSPF authentication type specifier. The type options are; default, md5, none, and simple.
Constants
usePassword 0 Use Password NO COMMENTS
useSshKeyContents 1 Use SSH Public/Private Files NO COMMENTS
DEFAULT usePassword(0) Use Password NO COMMENTS




childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies the description of a policy component.


dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.


epgDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Management EpG dn


host

Type: address:HostNameOrDottedQuad
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Regex: ˆ(?=.{0,255}$)[0-9A-Za-z:\[\]](\[{0,1})(?:(?:[0-9A-Za-z]|-|:){0,61}[0-9A-Za-z])?(?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-|:){0,61}[0-9A-Za-z])?)*\.?(\]{0,1})$
    Comments:
Hostname or IP for export destination


identityPrivateKeyContents

Type: string:CharBuffer

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
defaultValue "" --- NO COMMENTS




identityPrivateKeyPassphrase

Type: string:Basic

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
Passphrase given at the identity key creation.
Constants
defaultValue "" --- NO COMMENTS




identityPublicKeyContents

Type: string:CharBuffer

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Certificate contents for data transfer. Used for credentials.
Constants
defaultValue "" --- NO COMMENTS




name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
null


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS


protocol

Type: file:TransferProtocol
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Transfer prtocol to be used for data export
Constants
ftp 0 ftp NO COMMENTS
sftp 1 sftp NO COMMENTS
scp 2 scp NO COMMENTS
DEFAULT sftp(1) sftp NO COMMENTS




remotePath

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
Path where data will reside in the destination


remotePort

Type: address:PortNumber
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 65535
    Comments:
Remote port for data export destination


rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.





uri

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Generated path


userName

Type: aaa:UserName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Regex: [a-zA-Z0-9][a-zA-Z0-9_.-]{0,31}
    Comments:
Username to be used to transfer data to destination


userPasswd

Type: aaa:Key
Primitive Type: string:Password

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "32"
        Allowed Chars:
            Regex: .*
    Comments:
Password to be used to transfer data to destination


vrfName

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The vrf that remote host belongs to




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail