Camphor Networks Platform API
camphor_api.camphor_project_schema Namespace Reference

Classes

class  ApplicationName
 Name of the application. More...
 
class  ObjectMetaDefinition
 Common properties which apply to all configuration elemements. More...
 
class  ApplicationAttributesDefinition
 
class  ApplicationsItem
 
class  Applications
 Third-Party applications configuration. More...
 
class  BGPGroupPrefixBlockAttributesDefinition
 BgpGroup prefix block properties. More...
 
class  PrefixBlocksItem
 
class  PrefixBlocks
 List of prefixBlocks to advertise. More...
 
class  BGPGroupAttributesDefinition
 
class  BGPGroupsItem
 
class  BGPGroups
 Configure various camphor bgpGroups (L2) and their attributes. More...
 
class  BGPTesterAttributes
 Bgp Tester node related attributes to customize bgp testing. More...
 
class  Image
 Device boot image configuration attributes for the device (REs and LCs) More...
 
class  Location
 Device location attributes - Used in mapping as geo-location in openNMS. More...
 
class  DeviceOS
 Operating System (OS) of the device. More...
 
class  Resource
 Compute resources to allocate to the device VM. More...
 
class  DeviceType
 Type of this device. More...
 
class  DeviceAttributesDefinition
 device (VM Or Container) specific attributes More...
 
class  BorderLeafAttributes
 Data Center Border Leaf related attributes. More...
 
class  CoreAttributes
 Data Center Core Routers related attributes. More...
 
class  CustomAttributesDefinition
 User defined custom attributes as key value pairs. More...
 
class  OverlayConnectivity
 Select one of the popular standard oveerlay connectivity. More...
 
class  DeploymentType
 Select one of the popular standard deployment type. More...
 
class  UnderlayConnectivity
 Select one of the popular standard underlay connectivity. More...
 
class  DeploymentAttributes
 Deployment related attributes to customize the autogenerated topology. More...
 
class  LeafAttributes
 Data Center Leaf related attributes. More...
 
class  PodAttributes
 Data Center Pod related attributes. More...
 
class  RackAttributes
 Data Center Rack related attributes. More...
 
class  RouteReflectorAttributes
 Route Reflector related attributes. More...
 
class  ServerAttributes
 Data Center Server related attributes. More...
 
class  SpineAttributes
 Data Center Spine related attributes. More...
 
class  SuperSpineAttributes
 Data Center SuperSpine related attributes. More...
 
class  VPNAttributes
 L3 VPN related attributes. More...
 
class  DeploymentConfigurationAttributesDefinition
 Customize this deployment configuration. More...
 
class  BGPTestersItem
 
class  BGPTesters
 List of various bgpTesters to be created inside the datacenter. More...
 
class  BorderLeafsItem
 
class  BorderLeafs
 List of various border leaf routers to be created inside the datacenter. More...
 
class  CoresItem
 
class  Cores
 List of various core routers to be created inside the datacenter. More...
 
class  PurpleItem
 
class  ItemLeafs
 List of various leaf switches to be created inside the rack. More...
 
class  PodsItem
 List pods to be customized as desired. More...
 
class  Pods
 List of various pods to be created inside the datacenter. More...
 
class  RacksItem
 
class  Racks
 List of various racks to be created inside the pod. More...
 
class  RouteReflectorsItem
 
class  RouteReflectors
 List of various route reflectors to be created inside the datacenter. More...
 
class  ServersItem
 
class  Servers
 List of various servers to be created inside the rack. More...
 
class  SpinesItem
 
class  Spines
 List of various spine switches to be created inside the pod. More...
 
class  SuperSpinesItem
 
class  SuperSpines
 List of various super spine switches to be created inside the datacenter. More...
 
class  DeploymentAttributesDefinition
 Attributes of the deployment. More...
 
class  Deployments
 Deployments configuration. More...
 
class  DevicesItem
 
class  Devices
 Configure various devices and their configuration attributes under this section. More...
 
class  DrawingAttributesDefinition
 
class  DrawingsItem
 
class  Drawings
 Drawings configuration. More...
 
class  EsLeafAttributesDefinition
 ES Leaf properties. More...
 
class  FluffyItem
 
class  AttributesLeafs
 List of associated leaf switches. More...
 
class  EsAttributesDefinition
 
class  EsesItem
 
class  Eses
 Ethernet Segments (Eses) More...
 
class  EvpnAttributesDefinition
 
class  EvpnsItem
 
class  Evpns
 Evpns. More...
 
class  GUIAttributesDefinition
 
class  GuisItem
 
class  Guis
 Gui/Dashboard Customization Configurations. More...
 
class  HostType
 Type of the host endpoints. More...
 
class  HostAttributesDefinition
 
class  HostsItem
 
class  Hosts
 Host endpoints. More...
 
class  MetricType
 Type of this metric. More...
 
class  MetricAttributesDefinition
 
class  MetricsItem
 
class  Metrics
 Metric collectors. More...
 
class  MonitorMode
 Mode of this monitor. More...
 
class  MonitorAttributesDefinition
 
class  MonitorsItem
 
class  Monitors
 Metric monitors. More...
 
class  NetworkPortAttributesDefinition
 Network port properties. More...
 
class  PortsItem
 
class  Ports
 List of ports (device/interface to connect to this network) More...
 
class  NetworkAttributesDefinition
 
class  NetworksItem
 
class  Networks
 Configure various camphor networks (L2) and their attributes. More...
 
class  NotebookAttributesDefinition
 
class  NotebooksItem
 
class  Notebooks
 Jupyter Notebooks. More...
 
class  TrafficType
 Type of this traffic. More...
 
class  TrafficProfileAttributesDefinition
 Traffic Profile properties. More...
 
class  TrafficProfilesItem
 
class  TrafficProfiles
 List of traffic profile blocks. More...
 
class  ProfileType
 Type of this profile. More...
 
class  ProfileAttributesDefinition
 
class  ProfilesItem
 
class  Profiles
 Performance Profilers. More...
 
class  ProjectRole
 Role of this project: Either user/admin. More...
 
class  ProjectAttributesDefinition
 
class  ProjectsItem
 
class  Projects
 Projects configuration. More...
 
class  TableAttributesDefinition
 
class  TablesItem
 
class  Tables
 Tables. More...
 
class  TerminalAttributesDefinition
 
class  TerminalsItem
 
class  Terminals
 Terminals. More...
 
class  TestEventType
 Type of this test event. More...
 
class  TestEventAttributesDefinition
 
class  TestEventsItem
 
class  TestEvents
 TestEvents. More...
 
class  TopologyAttributesDefinition
 
class  TopologysItem
 
class  Topologys
 Third-Party applications configuration. More...
 
class  VPNAttributesDefinition
 
class  VpnsItem
 
class  Vpns
 Vpns. More...
 
class  VrfAttributesDefinition
 
class  VrfsItem
 
class  Vrfs
 vrfs More...
 
class  CamphorProjectSchema
 Configure various camphor network platform elements using this schema. More...
 

Functions

int from_int (Any x)
 
Any from_none (Any x)
 
def from_union (fs, x)
 
str from_str (Any x)
 
bool from_bool (Any x)
 
EnumT to_enum (Type[EnumT] c, Any x)
 
dict to_class (Type[T] c, Any x)
 
List[Tfrom_list (Callable[[Any], T] f, Any x)
 
CamphorProjectSchema CamphorProjectSchemafromdict (Any s)
 
Any CamphorProjectSchematodict (CamphorProjectSchema x)
 

Variables

 T = TypeVar("T")
 
 EnumT = TypeVar("EnumT", bound=Enum)
 

Function Documentation

◆ from_int()

int camphor_api.camphor_project_schema.from_int ( Any  x)

Definition at line 9 of file camphor_project_schema.py.

◆ from_none()

Any camphor_api.camphor_project_schema.from_none ( Any  x)

Definition at line 14 of file camphor_project_schema.py.

◆ from_union()

def camphor_api.camphor_project_schema.from_union (   fs,
  x 
)

Definition at line 19 of file camphor_project_schema.py.

Referenced by ObjectMetaDefinition.from_dict(), ApplicationAttributesDefinition.from_dict(), ApplicationsItem.from_dict(), Applications.from_dict(), BGPGroupPrefixBlockAttributesDefinition.from_dict(), PrefixBlocksItem.from_dict(), PrefixBlocks.from_dict(), BGPGroupAttributesDefinition.from_dict(), BGPGroupsItem.from_dict(), BGPGroups.from_dict(), BGPTesterAttributes.from_dict(), Image.from_dict(), Location.from_dict(), Resource.from_dict(), DeviceAttributesDefinition.from_dict(), BorderLeafAttributes.from_dict(), CoreAttributes.from_dict(), CustomAttributesDefinition.from_dict(), DeploymentAttributes.from_dict(), LeafAttributes.from_dict(), PodAttributes.from_dict(), RackAttributes.from_dict(), RouteReflectorAttributes.from_dict(), ServerAttributes.from_dict(), SpineAttributes.from_dict(), SuperSpineAttributes.from_dict(), VPNAttributes.from_dict(), DeploymentConfigurationAttributesDefinition.from_dict(), BGPTestersItem.from_dict(), BGPTesters.from_dict(), BorderLeafsItem.from_dict(), BorderLeafs.from_dict(), CoresItem.from_dict(), Cores.from_dict(), PurpleItem.from_dict(), ItemLeafs.from_dict(), PodsItem.from_dict(), Pods.from_dict(), RacksItem.from_dict(), Racks.from_dict(), RouteReflectorsItem.from_dict(), RouteReflectors.from_dict(), ServersItem.from_dict(), Servers.from_dict(), SpinesItem.from_dict(), Spines.from_dict(), SuperSpinesItem.from_dict(), SuperSpines.from_dict(), DeploymentAttributesDefinition.from_dict(), Deployments.from_dict(), DevicesItem.from_dict(), Devices.from_dict(), DrawingAttributesDefinition.from_dict(), DrawingsItem.from_dict(), Drawings.from_dict(), EsLeafAttributesDefinition.from_dict(), FluffyItem.from_dict(), AttributesLeafs.from_dict(), EsAttributesDefinition.from_dict(), EsesItem.from_dict(), Eses.from_dict(), EvpnAttributesDefinition.from_dict(), EvpnsItem.from_dict(), Evpns.from_dict(), GUIAttributesDefinition.from_dict(), GuisItem.from_dict(), Guis.from_dict(), HostAttributesDefinition.from_dict(), HostsItem.from_dict(), Hosts.from_dict(), MetricAttributesDefinition.from_dict(), MetricsItem.from_dict(), Metrics.from_dict(), MonitorAttributesDefinition.from_dict(), MonitorsItem.from_dict(), Monitors.from_dict(), NetworkPortAttributesDefinition.from_dict(), PortsItem.from_dict(), Ports.from_dict(), NetworkAttributesDefinition.from_dict(), NetworksItem.from_dict(), Networks.from_dict(), NotebookAttributesDefinition.from_dict(), NotebooksItem.from_dict(), Notebooks.from_dict(), TrafficProfileAttributesDefinition.from_dict(), TrafficProfilesItem.from_dict(), TrafficProfiles.from_dict(), ProfileAttributesDefinition.from_dict(), ProfilesItem.from_dict(), Profiles.from_dict(), ProjectAttributesDefinition.from_dict(), ProjectsItem.from_dict(), Projects.from_dict(), TableAttributesDefinition.from_dict(), TablesItem.from_dict(), Tables.from_dict(), TerminalAttributesDefinition.from_dict(), TerminalsItem.from_dict(), Terminals.from_dict(), TestEventAttributesDefinition.from_dict(), TestEventsItem.from_dict(), TestEvents.from_dict(), TopologyAttributesDefinition.from_dict(), TopologysItem.from_dict(), Topologys.from_dict(), VPNAttributesDefinition.from_dict(), VpnsItem.from_dict(), Vpns.from_dict(), VrfAttributesDefinition.from_dict(), VrfsItem.from_dict(), Vrfs.from_dict(), CamphorProjectSchema.from_dict(), ObjectMetaDefinition.to_dict(), ApplicationAttributesDefinition.to_dict(), ApplicationsItem.to_dict(), Applications.to_dict(), BGPGroupPrefixBlockAttributesDefinition.to_dict(), PrefixBlocksItem.to_dict(), PrefixBlocks.to_dict(), BGPGroupAttributesDefinition.to_dict(), BGPGroupsItem.to_dict(), BGPGroups.to_dict(), BGPTesterAttributes.to_dict(), Image.to_dict(), Location.to_dict(), Resource.to_dict(), DeviceAttributesDefinition.to_dict(), BorderLeafAttributes.to_dict(), CoreAttributes.to_dict(), CustomAttributesDefinition.to_dict(), DeploymentAttributes.to_dict(), LeafAttributes.to_dict(), PodAttributes.to_dict(), RackAttributes.to_dict(), RouteReflectorAttributes.to_dict(), ServerAttributes.to_dict(), SpineAttributes.to_dict(), SuperSpineAttributes.to_dict(), VPNAttributes.to_dict(), DeploymentConfigurationAttributesDefinition.to_dict(), BGPTestersItem.to_dict(), BGPTesters.to_dict(), BorderLeafsItem.to_dict(), BorderLeafs.to_dict(), CoresItem.to_dict(), Cores.to_dict(), PurpleItem.to_dict(), ItemLeafs.to_dict(), PodsItem.to_dict(), Pods.to_dict(), RacksItem.to_dict(), Racks.to_dict(), RouteReflectorsItem.to_dict(), RouteReflectors.to_dict(), ServersItem.to_dict(), Servers.to_dict(), SpinesItem.to_dict(), Spines.to_dict(), SuperSpinesItem.to_dict(), SuperSpines.to_dict(), DeploymentAttributesDefinition.to_dict(), Deployments.to_dict(), DevicesItem.to_dict(), Devices.to_dict(), DrawingAttributesDefinition.to_dict(), DrawingsItem.to_dict(), Drawings.to_dict(), EsLeafAttributesDefinition.to_dict(), FluffyItem.to_dict(), AttributesLeafs.to_dict(), EsAttributesDefinition.to_dict(), EsesItem.to_dict(), Eses.to_dict(), EvpnAttributesDefinition.to_dict(), EvpnsItem.to_dict(), Evpns.to_dict(), GUIAttributesDefinition.to_dict(), GuisItem.to_dict(), Guis.to_dict(), HostAttributesDefinition.to_dict(), HostsItem.to_dict(), Hosts.to_dict(), MetricAttributesDefinition.to_dict(), MetricsItem.to_dict(), Metrics.to_dict(), MonitorAttributesDefinition.to_dict(), MonitorsItem.to_dict(), Monitors.to_dict(), NetworkPortAttributesDefinition.to_dict(), PortsItem.to_dict(), Ports.to_dict(), NetworkAttributesDefinition.to_dict(), NetworksItem.to_dict(), Networks.to_dict(), NotebookAttributesDefinition.to_dict(), NotebooksItem.to_dict(), Notebooks.to_dict(), TrafficProfileAttributesDefinition.to_dict(), TrafficProfilesItem.to_dict(), TrafficProfiles.to_dict(), ProfileAttributesDefinition.to_dict(), ProfilesItem.to_dict(), Profiles.to_dict(), ProjectAttributesDefinition.to_dict(), ProjectsItem.to_dict(), Projects.to_dict(), TableAttributesDefinition.to_dict(), TablesItem.to_dict(), Tables.to_dict(), TerminalAttributesDefinition.to_dict(), TerminalsItem.to_dict(), Terminals.to_dict(), TestEventAttributesDefinition.to_dict(), TestEventsItem.to_dict(), TestEvents.to_dict(), TopologyAttributesDefinition.to_dict(), TopologysItem.to_dict(), Topologys.to_dict(), VPNAttributesDefinition.to_dict(), VpnsItem.to_dict(), Vpns.to_dict(), VrfAttributesDefinition.to_dict(), VrfsItem.to_dict(), Vrfs.to_dict(), and CamphorProjectSchema.to_dict().

+ Here is the caller graph for this function:

◆ from_str()

◆ from_bool()

bool camphor_api.camphor_project_schema.from_bool ( Any  x)

Definition at line 33 of file camphor_project_schema.py.

◆ to_enum()

◆ to_class()

dict camphor_api.camphor_project_schema.to_class ( Type[T c,
Any  x 
)

Definition at line 43 of file camphor_project_schema.py.

Referenced by camphor_api.camphor_project_schema.CamphorProjectSchematodict(), ApplicationAttributesDefinition.to_dict(), ApplicationsItem.to_dict(), Applications.to_dict(), BGPGroupPrefixBlockAttributesDefinition.to_dict(), PrefixBlocksItem.to_dict(), PrefixBlocks.to_dict(), BGPGroupAttributesDefinition.to_dict(), BGPGroupsItem.to_dict(), BGPGroups.to_dict(), DeviceAttributesDefinition.to_dict(), BorderLeafAttributes.to_dict(), CoreAttributes.to_dict(), LeafAttributes.to_dict(), PodAttributes.to_dict(), RackAttributes.to_dict(), RouteReflectorAttributes.to_dict(), ServerAttributes.to_dict(), SpineAttributes.to_dict(), SuperSpineAttributes.to_dict(), VPNAttributes.to_dict(), DeploymentConfigurationAttributesDefinition.to_dict(), BGPTestersItem.to_dict(), BGPTesters.to_dict(), BorderLeafsItem.to_dict(), BorderLeafs.to_dict(), CoresItem.to_dict(), Cores.to_dict(), PurpleItem.to_dict(), ItemLeafs.to_dict(), PodsItem.to_dict(), Pods.to_dict(), RacksItem.to_dict(), Racks.to_dict(), RouteReflectorsItem.to_dict(), RouteReflectors.to_dict(), ServersItem.to_dict(), Servers.to_dict(), SpinesItem.to_dict(), Spines.to_dict(), SuperSpinesItem.to_dict(), SuperSpines.to_dict(), DeploymentAttributesDefinition.to_dict(), Deployments.to_dict(), DevicesItem.to_dict(), Devices.to_dict(), DrawingAttributesDefinition.to_dict(), DrawingsItem.to_dict(), Drawings.to_dict(), EsLeafAttributesDefinition.to_dict(), FluffyItem.to_dict(), AttributesLeafs.to_dict(), EsAttributesDefinition.to_dict(), EsesItem.to_dict(), Eses.to_dict(), EvpnAttributesDefinition.to_dict(), EvpnsItem.to_dict(), Evpns.to_dict(), GUIAttributesDefinition.to_dict(), GuisItem.to_dict(), Guis.to_dict(), HostAttributesDefinition.to_dict(), HostsItem.to_dict(), Hosts.to_dict(), MetricAttributesDefinition.to_dict(), MetricsItem.to_dict(), Metrics.to_dict(), MonitorAttributesDefinition.to_dict(), MonitorsItem.to_dict(), Monitors.to_dict(), NetworkPortAttributesDefinition.to_dict(), PortsItem.to_dict(), Ports.to_dict(), NetworkAttributesDefinition.to_dict(), NetworksItem.to_dict(), Networks.to_dict(), NotebookAttributesDefinition.to_dict(), NotebooksItem.to_dict(), Notebooks.to_dict(), TrafficProfileAttributesDefinition.to_dict(), TrafficProfilesItem.to_dict(), TrafficProfiles.to_dict(), ProfileAttributesDefinition.to_dict(), ProfilesItem.to_dict(), Profiles.to_dict(), ProjectAttributesDefinition.to_dict(), ProjectsItem.to_dict(), Projects.to_dict(), TableAttributesDefinition.to_dict(), TablesItem.to_dict(), Tables.to_dict(), TerminalAttributesDefinition.to_dict(), TerminalsItem.to_dict(), Terminals.to_dict(), TestEventAttributesDefinition.to_dict(), TestEventsItem.to_dict(), TestEvents.to_dict(), TopologyAttributesDefinition.to_dict(), TopologysItem.to_dict(), Topologys.to_dict(), VPNAttributesDefinition.to_dict(), VpnsItem.to_dict(), Vpns.to_dict(), VrfAttributesDefinition.to_dict(), VrfsItem.to_dict(), Vrfs.to_dict(), and CamphorProjectSchema.to_dict().

+ Here is the caller graph for this function:

◆ from_list()

List[T] camphor_api.camphor_project_schema.from_list ( Callable[[Any], T f,
Any  x 
)

Definition at line 48 of file camphor_project_schema.py.

Referenced by Applications.from_dict(), PrefixBlocks.from_dict(), BGPGroups.from_dict(), Image.from_dict(), Resource.from_dict(), DeviceAttributesDefinition.from_dict(), BGPTesters.from_dict(), BorderLeafs.from_dict(), Cores.from_dict(), ItemLeafs.from_dict(), Pods.from_dict(), Racks.from_dict(), RouteReflectors.from_dict(), Servers.from_dict(), Spines.from_dict(), SuperSpines.from_dict(), Deployments.from_dict(), Devices.from_dict(), Drawings.from_dict(), AttributesLeafs.from_dict(), Eses.from_dict(), Evpns.from_dict(), Guis.from_dict(), Hosts.from_dict(), Metrics.from_dict(), Monitors.from_dict(), Ports.from_dict(), Networks.from_dict(), Notebooks.from_dict(), TrafficProfiles.from_dict(), ProfileAttributesDefinition.from_dict(), Profiles.from_dict(), Projects.from_dict(), Tables.from_dict(), Terminals.from_dict(), TestEventAttributesDefinition.from_dict(), TestEvents.from_dict(), Topologys.from_dict(), Vpns.from_dict(), Vrfs.from_dict(), Applications.to_dict(), PrefixBlocks.to_dict(), BGPGroups.to_dict(), Image.to_dict(), Resource.to_dict(), DeviceAttributesDefinition.to_dict(), BGPTesters.to_dict(), BorderLeafs.to_dict(), Cores.to_dict(), ItemLeafs.to_dict(), Pods.to_dict(), Racks.to_dict(), RouteReflectors.to_dict(), Servers.to_dict(), Spines.to_dict(), SuperSpines.to_dict(), Deployments.to_dict(), Devices.to_dict(), Drawings.to_dict(), AttributesLeafs.to_dict(), Eses.to_dict(), Evpns.to_dict(), Guis.to_dict(), Hosts.to_dict(), Metrics.to_dict(), Monitors.to_dict(), Ports.to_dict(), Networks.to_dict(), Notebooks.to_dict(), TrafficProfiles.to_dict(), ProfileAttributesDefinition.to_dict(), Profiles.to_dict(), Projects.to_dict(), Tables.to_dict(), Terminals.to_dict(), TestEventAttributesDefinition.to_dict(), TestEvents.to_dict(), Topologys.to_dict(), Vpns.to_dict(), and Vrfs.to_dict().

+ Here is the caller graph for this function:

◆ CamphorProjectSchemafromdict()

CamphorProjectSchema camphor_api.camphor_project_schema.CamphorProjectSchemafromdict ( Any  s)

Definition at line 4864 of file camphor_project_schema.py.

◆ CamphorProjectSchematodict()

Any camphor_api.camphor_project_schema.CamphorProjectSchematodict ( CamphorProjectSchema  x)

Definition at line 4868 of file camphor_project_schema.py.

References camphor_api.camphor_project_schema.to_class().

+ Here is the call graph for this function:

Variable Documentation

◆ T

T = TypeVar("T")

Definition at line 5 of file camphor_project_schema.py.

◆ EnumT

EnumT = TypeVar("EnumT", bound=Enum)

Definition at line 6 of file camphor_project_schema.py.