Class callhome:Prof (CONCRETE)

Class ID:1693
Class Label: Callhome protocol profile
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin]
Read Access: [admin, ops]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

Contains all site information and the address of the SMTP server used to send emails.

Naming Rules
RN FORMAT: prof

    [1] PREFIX=prof


DN FORMAT: 

[1] uni/fabric/chgroup-{name}/prof

                


Diagram

Super Mo: mon:ProtoP,
Container Mos: callhome:Group (deletable:yes),
Contained Mos: callhome:SmtpServer,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 
 
 
 
 
 ├
[V] callhome:Group Call Home provides an email-based notification for critical system policies. A range of message formats are available for compatibility with pager services or XML-based automated parsing applications. You can use this feature to page a network support engineer, email a Network Operations Center, or use Cisco Smart Call Home services to generate a case with the Technical Assistance Center.
 
 
 
 
 
 
 
 
 ├
[V] callhome:Prof Contains all site information and the address of the SMTP server used to send emails.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 ├
[V] callhome:Group Call Home provides an email-based notification for critical system policies. A range of message formats are available for compatibility with pager services or XML-based automated parsing applications. You can use this feature to page a network support engineer, email a Network Operations Center, or use Cisco Smart Call Home services to generate a case with the Technical Assistance Center.
 
 
 
 ├
[V] callhome:Prof Contains all site information and the address of the SMTP server used to send emails.


Contained Hierarchy
[V] callhome:Prof Contains all site information and the address of the SMTP server used to send emails.
 ├
[V] callhome:SmtpServer The hostname or IP for export destination. Call Home sends email messages to either the IP address or hostname, and the associated port number.
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 ├
[V] file:RsARemoteHostToEpg A source relation to the endpoint group through which the remote host is reachable.
 
 ├
[V] file:RsARemoteHostToEpp A source relation to the abstract representation of the resolvable endpoint profile.
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


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] mon:ProtoP The objects in the hierarchy under mon:Pol (Policy, Target Subjects, ...) that define scopes for monitoring activities, including statistics reporting and notification dispatching. To enable notification dispatching, a user attaches a mon:Src object under the object with the desired scope. The source provides an association to a group, which contains all the information needed to dispatch notifications to a set of destinations using a specifie...
 
 
 
 ├
[V] callhome:Prof Contains all site information and the address of the SMTP server used to send emails.


Events
                callhome:Prof:creation__callhome_Prof
callhome:Prof:modification__callhome_Prof
callhome:Prof:deletion__callhome_Prof


Faults
                


Fsms
                


Properties Summary
Defined in: callhome:Prof
callhome:ContactAddress
          string:Basic
addr  (callhome:Prof:addr)
           The contact address of the customer.
callhome:ContactName
          string:Basic
contact  (callhome:Prof:contact)
           The customer contact ID. Note that the customer ID associated with the Smart Call Home configuration in Cisco UCS must be the CCO (Cisco.com) account name associated with a support contract that includes Smart Call Home.
string:Basic contract  (callhome:Prof:contract)
           The contract information provided by the customer.
string:Basic customer  (callhome:Prof:customer)
           The customer for the Call Home profile.
callhome:Email
          string:Basic
email  (callhome:Prof:email)
           The email address of the contact for the system or site. This address is not necessarily the same as the reply-to addresses used in the outgoing emails.
callhome:Email
          string:Basic
from  (callhome:Prof:from)
           The email address of the sender.
reference:BinRef monPolDn  (callhome:Prof:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (callhome:Prof:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The user-configured profile name.
callhome:Phone
          string:Basic
phone  (callhome:Prof:phone)
           The contact phone number.
mon:Port
          scalar:Uint32
port  (callhome:Prof:port)
           Overrides:mon:ProtoP:port
           The SMTP server port number. The SMTP server address must be configured for the Callhome functionality to work.
callhome:Email
          string:Basic
replyTo  (callhome:Prof:replyTo)
           The Reply-To email address for emails sent using the destination group policy.
string:Basic site  (callhome:Prof:site)
           The site ID provided by the customer. This is the ID of the network where the site is deployed.
mon:Transport
          scalar:Enum8
transport  (callhome:Prof:transport)
           Overrides:mon:ProtoP:transport
           The transport protocol for connecting to the SMTP server.
Defined in: mon:ProtoP
mon:AdminState
          scalar:Enum8
adminState  (mon:ProtoP:adminState)
           null
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
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.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

addr

Type: callhome:ContactAddress
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "255"
    Comments:
The contact address of the customer.



adminState

Type: mon:AdminState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
null
Constants
enabled 1 enabled NO COMMENTS
disabled 2 disabled NO COMMENTS
DEFAULT enabled(1) enabled 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





contact

Type: callhome:ContactName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "255"
    Comments:
The customer contact ID. Note that the customer ID associated with the Smart Call Home configuration in Cisco UCS must be the CCO (Cisco.com) account name associated with a support contract that includes Smart Call Home.



contract

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The contract information provided by the customer.



customer

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The customer for the Call Home profile.



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.



email

Type: callhome:Email
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Regex: ˆ$|ˆ(?!.{64,})[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+$
    Comments:
The email address of the contact for the system or site. This address is not necessarily the same as the reply-to addresses used in the outgoing emails.



from

Type: callhome:Email
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Regex: ˆ$|ˆ(?!.{64,})[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+$
    Comments:
The email address of the sender.



lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  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:
The user-configured profile name.
Constants
defaultValue "callhome" --- NO COMMENTS





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



phone

Type: callhome:Phone
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
    Comments:
The contact phone number.



port

Type: mon:Port
Primitive Type: scalar:Uint32

Overrides:mon:ProtoP:port
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: (long)0l max: (long)65535l
    Comments:
The SMTP server port number. The SMTP server address must be configured for the Callhome functionality to work.
Constants
defaultValue 25u --- NO COMMENTS





replyTo

Type: callhome:Email
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Regex: ˆ$|ˆ(?!.{64,})[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+$
    Comments:
The Reply-To email address for emails sent using the destination group policy.



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.



site

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The site ID provided by the customer. This is the ID of the network where the site is deployed.



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.






transport

Type: mon:Transport
Primitive Type: scalar:Enum8

Overrides:mon:ProtoP:transport
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The transport protocol for connecting to the SMTP server.
Constants
none 0 none NO COMMENTS
tcp 1 tcp NO COMMENTS
udp 2 udp NO COMMENTS
all 3 all NO COMMENTS
DEFAULT tcp(1) tcp NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.