.. Class Doc file

class cobra.model.fv.Tenant
===========================
.. class:: cobra.model.fv.Tenant

A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.

    Containers:
      * :class:`cobra.model.pol.Uni`

    Containment:
      * :class:`cobra.model.l2.EgrPktsAg15min`
      * :class:`cobra.model.vns.CtrlrMgmtPol`
      * :class:`cobra.model.l2.EgrBytesAgHist15min`
      * :class:`cobra.model.vz.ERFltP`
      * :class:`cobra.model.l2.EgrPktsAgHist1qtr`
      * :class:`cobra.model.tag.Inst`
      * :class:`cobra.model.rtctrl.SubjP`
      * :class:`cobra.model.igmp.SnoopPol`
      * :class:`cobra.model.fvns.AddrInst`
      * :class:`cobra.model.vns.Chassis`
      * :class:`cobra.model.l2.IngrBytesAg1w`
      * :class:`cobra.model.vns.CRel`
      * :class:`cobra.model.tag.AliasDelInst`
      * :class:`cobra.model.vns.LDevCtx`
      * :class:`cobra.model.l2.IngrPktsAg1qtr`
      * :class:`cobra.model.dbgac.EpgToIp`
      * :class:`cobra.model.ospf.IfPol`
      * :class:`cobra.model.l2.IngrBytesAg1d`
      * :class:`cobra.model.nd.PfxPol`
      * :class:`cobra.model.l2.EgrBytesAg15min`
      * :class:`cobra.model.bgp.CtxPol`
      * :class:`cobra.model.health.NodeInst`
      * :class:`cobra.model.l2.EgrBytesAgHist1mo`
      * :class:`cobra.model.ospf.CtxPol`
      * :class:`cobra.model.l2.EgrBytesAg1h`
      * :class:`cobra.model.bgp.RtSummPol`
      * :class:`cobra.model.span.VSrcGrp`
      * :class:`cobra.model.l3ext.Out`
      * :class:`cobra.model.l2.EgrBytesAg1d`
      * :class:`cobra.model.l2.EgrPktsAg1year`
      * :class:`cobra.model.vz.BrCP`
      * :class:`cobra.model.fv.OverallHealthHist15min`
      * :class:`cobra.model.fv.OverallHealth1mo`
      * :class:`cobra.model.l2.EgrBytesAg1w`
      * :class:`cobra.model.vns.GraphInst`
      * :class:`cobra.model.l2.EgrPktsAgHist1h`
      * :class:`cobra.model.fault.Inst`
      * :class:`cobra.model.rtctrl.Profile`
      * :class:`cobra.model.fv.RtTenant`
      * :class:`cobra.model.l2.IngrBytesAg15min`
      * :class:`cobra.model.traceroutep.TrEpExt`
      * :class:`cobra.model.nd.IfPol`
      * :class:`cobra.model.vns.UnitHolder`
      * :class:`cobra.model.vns.CfgRelInst`
      * :class:`cobra.model.fv.EpRetPol`
      * :class:`cobra.model.mon.EPGPol`
      * :class:`cobra.model.l2.EgrPktsAgHist1w`
      * :class:`cobra.model.l2.IngrPktsAg1mo`
      * :class:`cobra.model.vz.Filter`
      * :class:`cobra.model.vns.LDevVip`
      * :class:`cobra.model.vz.CPIf`
      * :class:`cobra.model.fv.OverallHealthHist1d`
      * :class:`cobra.model.l2.IngrPktsAg1w`
      * :class:`cobra.model.l2.EgrBytesAgHist1w`
      * :class:`cobra.model.eigrp.RtSummPol`
      * :class:`cobra.model.fv.OverallHealthHist1h`
      * :class:`cobra.model.fv.OverallHealthHist1qtr`
      * :class:`cobra.model.fv.OverallHealthHist1w`
      * :class:`cobra.model.l2.IngrPktsAg1d`
      * :class:`cobra.model.l2.EgrBytesAgHist1h`
      * :class:`cobra.model.l2.IngrPktsAg1h`
      * :class:`cobra.model.l2.EgrBytesAgHist1d`
      * :class:`cobra.model.dhcp.OptionPol`
      * :class:`cobra.model.dbgac.ExtToEp`
      * :class:`cobra.model.l2.EgrPktsAgHist1d`
      * :class:`cobra.model.l2.EgrBytesAgHist1year`
      * :class:`cobra.model.fv.SvcBD`
      * :class:`cobra.model.vns.AbsGraph`
      * :class:`cobra.model.mgmt.ExtMgmtEntity`
      * :class:`cobra.model.vns.InBHolder`
      * :class:`cobra.model.dbgac.AnyToEp`
      * :class:`cobra.model.l2.EgrPktsAgHist15min`
      * :class:`cobra.model.l2ext.Out`
      * :class:`cobra.model.l2.IngrBytesAg1mo`
      * :class:`cobra.model.rtctrl.AttrP`
      * :class:`cobra.model.eigrp.CtxAfPol`
      * :class:`cobra.model.fv.OverallHealth1w`
      * :class:`cobra.model.aaa.PartialRbacRule`
      * :class:`cobra.model.fv.BD`
      * :class:`cobra.model.fv.Ctx`
      * :class:`cobra.model.fv.OverallHealth1d`
      * :class:`cobra.model.l2.EgrPktsAgHist1year`
      * :class:`cobra.model.l2.EgrPktsAg1mo`
      * :class:`cobra.model.fv.OverallHealth1h`
      * :class:`cobra.model.span.DestGrp`
      * :class:`cobra.model.dbgac.EpgToEpg`
      * :class:`cobra.model.fv.Ap`
      * :class:`cobra.model.l2.EgrBytesAg1mo`
      * :class:`cobra.model.vns.GRel`
      * :class:`cobra.model.fv.OverallHealthHist1mo`
      * :class:`cobra.model.dbgac.EpgToEp`
      * :class:`cobra.model.l2.IngrBytesAgHist1mo`
      * :class:`cobra.model.dbgac.EpToExt`
      * :class:`cobra.model.vns.AbsFuncProfContr`
      * :class:`cobra.model.vns.FolderInst`
      * :class:`cobra.model.vns.DevMgr`
      * :class:`cobra.model.l2.IngrPktsAgHist1year`
      * :class:`cobra.model.fault.CountsWithDetails`
      * :class:`cobra.model.infra.ClP`
      * :class:`cobra.model.l2.IngrBytesAg1qtr`
      * :class:`cobra.model.draw.Cont`
      * :class:`cobra.model.l2.IngrBytesAgHist1year`
      * :class:`cobra.model.vns.AbsCfgRel`
      * :class:`cobra.model.dbgac.EpToEpg`
      * :class:`cobra.model.l2.IngrBytesAg1h`
      * :class:`cobra.model.l2.EgrPktsAg1qtr`
      * :class:`cobra.model.health.Inst`
      * :class:`cobra.model.fv.OverallHealth15min`
      * :class:`cobra.model.dbgac.EpToEp`
      * :class:`cobra.model.infra.ProvP`
      * :class:`cobra.model.l2.IngrPktsAgHist1d`
      * :class:`cobra.model.l2.IngrPktsAgHist15min`
      * :class:`cobra.model.aaa.DomainRef`
      * :class:`cobra.model.tag.AliasInst`
      * :class:`cobra.model.dhcp.RelayP`
      * :class:`cobra.model.vns.GFolder`
      * :class:`cobra.model.qos.DppPol`
      * :class:`cobra.model.bgp.CtxAfPol`
      * :class:`cobra.model.vns.LDevInst`
      * :class:`cobra.model.vns.CFolder`
      * :class:`cobra.model.fv.ConnInstrPol`
      * :class:`cobra.model.dbgac.IpToIp`
      * :class:`cobra.model.l2.IngrPktsAgHist1mo`
      * :class:`cobra.model.eigrp.IfPol`
      * :class:`cobra.model.vns.ParamInst`
      * :class:`cobra.model.vns.GParam`
      * :class:`cobra.model.l2.IngrPktsAg15min`
      * :class:`cobra.model.qos.CustomPol`
      * :class:`cobra.model.l2.EgrPktsAg1h`
      * :class:`cobra.model.fv.OverallHealth1year`
      * :class:`cobra.model.vns.RtrCfg`
      * :class:`cobra.model.vns.NatInst`
      * :class:`cobra.model.l2.EgrPktsAg1d`
      * :class:`cobra.model.vns.LDevIf`
      * :class:`cobra.model.vz.RFltP`
      * :class:`cobra.model.fv.OverallHealth1qtr`
      * :class:`cobra.model.mgmt.MgmtP`
      * :class:`cobra.model.fault.Delegate`
      * :class:`cobra.model.l2.IngrPktsAgHist1qtr`
      * :class:`cobra.model.l2.EgrPktsAg1w`
      * :class:`cobra.model.l2.IngrBytesAgHist15min`
      * :class:`cobra.model.l2.IngrBytesAgHist1d`
      * :class:`cobra.model.ospf.RtSummPol`
      * :class:`cobra.model.bfd.Ipv4IfPol`
      * :class:`cobra.model.l2.IngrPktsAgHist1w`
      * :class:`cobra.model.l2.IngrBytesAgHist1h`
      * :class:`cobra.model.vz.OOBBrCP`
      * :class:`cobra.model.l2.EgrBytesAgHist1qtr`
      * :class:`cobra.model.l3ext.OutDef`
      * :class:`cobra.model.vns.FWReq`
      * :class:`cobra.model.l2.IngrBytesAgHist1qtr`
      * :class:`cobra.model.l2.IngrBytesAgHist1w`
      * :class:`cobra.model.dbgac.IpToEpg`
      * :class:`cobra.model.bgp.PeerPfxPol`
      * :class:`cobra.model.vns.AbsFolder`
      * :class:`cobra.model.l2.IngrBytesAg1year`
      * :class:`cobra.model.vns.CParam`
      * :class:`cobra.model.l2.EgrPktsAgHist1mo`
      * :class:`cobra.model.l2.IngrPktsAg1year`
      * :class:`cobra.model.traceroutep.TrEp`
      * :class:`cobra.model.bfd.Ipv6IfPol`
      * :class:`cobra.model.l3ext.RouteTagPol`
      * :class:`cobra.model.span.SrcGrp`
      * :class:`cobra.model.span.VDestGrp`
      * :class:`cobra.model.fv.OverallHealthHist1year`
      * :class:`cobra.model.vz.Taboo`
      * :class:`cobra.model.vns.DevProf`
      * :class:`cobra.model.l2.EgrBytesAg1qtr`
      * :class:`cobra.model.l2.EgrBytesAg1year`
      * :class:`cobra.model.fv.RsTnDenyRule`
      * :class:`cobra.model.l2.IngrPktsAgHist1h`
      * :class:`cobra.model.dbgac.EpToAny`
      * :class:`cobra.model.fv.RsTenantMonPol`
      * :class:`cobra.model.vns.AbsParam`

    Properties:
      - childAction : Delete or ignore. For internal use only.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - descr : The description of the tenant.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - dn : A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

          + isNaming: False
          + isCreateOnly: True
          + isConfig: False
          + isImplicit: True

      - lcOwn : A value that indicates how this object was created. For internal use only.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - modTs : The time when this object was last modified.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - monPolDn : Monitoring policy attached to this observable object

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - name : The name of the tenant.

          + isNaming: True
          + isCreateOnly: True
          + isConfig: True
          + isImplicit: False

      - ownerKey : The key for enabling clients to own their data for entity correlation.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - ownerTag : A tag for enabling clients to add their own data. For example, to indicate who created this object.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - rn : Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

          + isNaming: False
          + isCreateOnly: True
          + isConfig: False
          + isImplicit: True

      - status : The upgrade status. This property is for internal use only.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - uid : A unique identifier for this object.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True