b31eaad22b3f6b1f593d378dd2f065d73db034cb
[ccsdk/apps.git] / sdnr / wireless-transport / code-Carbon-SR1 / apps / devicemodel / src / main / yang / CoreModel-CoreFoundationModule-StateModel@2016-08-09.yang
1 module CoreModel-CoreFoundationModule-StateModel {
2     namespace "uri:onf:CoreModel-CoreFoundationModule-StateModel";
3     prefix CoreModel-CoreFoundationModule-StateModel;
4
5
6     organization 
7         'ONF (Open Networking Foundation) Open Transport Working Group - Wireless Transport Project';
8
9     contact 
10         'WG Web:   <https://www.opennetworking.org/technical-communities/areas/specification/1931-optical-transport>
11          WG List:  <mailto:wireless-transport@login.opennetworking.org >
12          WG Chair: Lyndon Ong
13                    <mailto:lyong@ciena.com>
14          WG Chair: Giorgio Cazzaniga
15                    <mailto:giorgio.cazzaniga@sm-optics.com>';
16
17     description 
18         'This module contains a collection of YANG definitions for 
19          managing microwave transport networks.';
20
21     revision 2016-08-09 {
22         description 
23             "Initial revision."; 
24         reference 
25             "ONF TR xyz: A YANG Data Model for Microwave Transport Networks."; 
26     }
27
28     grouping State_Pac {
29         description "Provides general state attributes.
30             lifecycle:Preliminary";
31         leaf operationalState {
32             type OperationalState;
33             config false;
34             description "The operational state is used to indicate whether or not the resource is installed and working";
35         }
36         leaf administrativeControl {
37             type AdministrativeControl;
38             description "The administrativeControl state provides control of the availability of specific resources without modification to the provisioning of those resources.
39                 The value is the current control target. The actual administrativeState may or may not be at target.";
40         }
41         leaf administrativeState {
42             type AdministrativeState;
43             config false;
44             description "Shows whether or not the client has permission to use or has a prohibition against using the resource.
45                 The administrative state expresses usage permissions for specific resources without modification to the provisioning of those resources.";
46         }
47         leaf lifecycleState {
48             type LifecycleState;
49             description "Used to track the planned deployment, allocation to clients and withdrawal of resources. ";
50         }
51     }
52     typedef OperationalState {
53         description "The possible values of the operationalState.
54             lifecycle:Preliminary";
55         type enumeration {
56             enum DISABLED;
57             enum ENABLED;
58         }
59     }
60     typedef AdministrativeState {
61         description "The possible values of the administrativeState.
62             lifecycle:Preliminary";
63         type enumeration {
64             enum LOCKED;
65             enum UNLOCKED;
66         }
67     }
68     typedef AdministrativeControl {
69         description "Reflects the current control action when the entity is not in the desired state.
70             The possible values of the current target administrative state.
71             lifecycle:Experimental";
72         type enumeration {
73             enum UNLOCK;
74             enum LOCK_PASSIVE;
75             enum LOCK_ACTIVE;
76             enum LOCK_IMMEDIATE;
77         }
78     }
79     typedef ExtendedAdminState {
80         description "Possible extentions to AdministrativeState
81             lifecycle:Experimental";
82         type enumeration {
83             enum LOCKED;
84             enum UNLOCKED;
85             enum SHUTTING_DOWN_ACTIVE;
86             enum SHUTTING_DOWN_PASSIVE;
87         }
88     }
89     typedef LifecycleState {
90         description "The possible values of the lifecycleState.
91             lifecycle:Experimental";
92         type enumeration {
93             enum PLANNED;
94             enum POTENTIAL;
95             enum INSTALLED;
96             enum PENDING_REMOVAL;
97         }
98     }
99 }