Class CIM_NetworkPolicyService
extends CIM_Service

This class describes a network policy service. The network policy service can used to manage network policies like firewall, load balancing, QoS, DHCP, and DNS. Typically, this network policy service corresponds to an abstraction of the service within a domain (for example, an orchestration layer).

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_NetworkPolicyService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis class describes a network policy service. The network policy service can used to manage network policies like firewall, load balancing, QoS, DHCP, and DNS. Typically, this network policy service corresponds to an abstraction of the service within a domain (for example, an orchestration layer).
UMLPackagePathstringCIM::Network
Versionstring2.54.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
OtherServiceTypeDescriptionstring
DescriptionstringA string that describes the network policy service type when the ServiceType is set to 1 ("Other").
ServiceIDstring
DescriptionstringThis property identifies an instance of a network policy service.
ModelCorrespondencestringCIM_NetworkPolicyService.ServiceIDType
ServiceIDTypeuint16
DescriptionstringThis property describes the type of identifier used to identify an instance of a network policy service.
ModelCorrespondencestringCIM_NetworkPolicyService.ServiceID
ValueMapstring2, 3, .., 32768..65535
ValuesstringURI, UUID, DMTF Reserved, Vendor Reserved
ServiceTypeuint16
DescriptionstringThis property describes the type of network policy service supported. This property does not identify an instance of a specific type of network policy service. Load Balancer: describes a load balancing service for the management and application of load balancer policies and rules. QoS: describes a Quality of Service (QoS) service for the management and application of QoS policies and rules. Firewall: describes a firewalling service for the management and application of firewall policies and rules. VPN: describes a Virtual Private Network (VPN) service for the configuration and management of VPNs. DHCPv4: describes a DHCP service for automatic network configuration of client systems on IPv4 networks. DHCPv6: describes a DHCP service for automatic network configuration of client systems on IPv6 networks. DNS: describes a Dynamic Name System (DNS) resolution service. NAT: describes a Network Address Translation (NAT) service for the configuration of NAT rules. Gateway: describes a gateway service for the configuration and management of gateway's functionalities. Layer4 Port Forwarding: describes a Port Forwarding service based on Layer 4 protocols for the configuration of port forwarding rules. IP Routing: describes a IP routing service for the configuration and management of routing rules.
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535
ValuesstringOther, Load Balancer, QoS, Firewall, VPN, DHCPv4, DHCPv6, DNS, NAT, Gateway, Layer4 Port Forwarding, IP Routing, DMTF Reserved, Vendor Reserved

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreatePolicyRule (uint32)

Method Qualifiers (CreatePolicyRule)

NameData TypeValue
DescriptionstringThis method creates an instance of CIM_NetworkPolicyRule class and instances of CIM_NetworkPolicyCondition, CIM_NetworkPolicyAction, CIM_NetworkPolicyRuleSettingData, and CIM_NetworkPolicyActionSettingData classes and all mandatory associations between these instances

Method Parameters (CreatePolicyRule)

NameTypeQualifiers
NameData TypeValue
ActionsOrderuint16[]
ArrayTypestringIndexed
DescriptionstringAn optional array corresponding to the NetworkPolicyAction, ActionOrder is an unsigned integer that indicates the relative position of a PolicyAction in the sequence of actions associated with a NetworkPolicyRule. This parameter populates the ActionOrder parameter in the corresponding CIM_PolicyActionInPolicyRule association instance.
ConditionGroupNumberuint16[]
DescriptionstringAn array unsigned integer corresponding to the NetworkPolicyCondition input indicating the group to which the contained NetworkPolicyCondition belongs. This integer segments the Conditions into the ANDed sets (when the ConditionListType is "DNF") or similarly, into the ORed sets (when the ConditionListType is "CNF"). This value is used to populate the ConditionGroupNumber property in the association in the corresponding association CIM_PolicyConditionInPolicyRule
NetworkPolicyActionstring[]
ArrayTypestringIndexed
Descriptionstringan array of embedded instances of the class CIM_NetworkPolicyAction associated with the created rule. This array is indexed with the ActionOrder parameter.
EmbeddedInstancestringCIM_NetworkPolicyAction
NetworkPolicyActionSettingDatastring[]
DescriptionstringAn embedded instance of CIM_NetworkPolicyActionSettingData. This array corresponds to the NetworkPolicyAction input array, the created instance of the embedded class is associated with the corresponding CIM_NetworkPolicyAction.
EmbeddedInstancestringCIM_NetworkPolicyActionSettingData
NetworkPolicyConditionstring[]
DescriptionstringAn array of enbedded instance of the class CIM_NetworkPolicyCondition to be associated with the created rule rule.
EmbeddedInstancestringCIM_NetworkPolicyCondition
NetworkPolicyRuleSettingDatastring[]
DescriptionstringAn embedded instance of CIM_NetworkPolicyRuleSettingData. This array corresponds to the NetworkPolicyRule input array, the created instance of the embedded class is associated with the corresponding CIM_NetworkPolicyRule.
EmbeddedInstancestringCIM_NetworkPolicyRuleSettingData
NetworkPolicyRule REF CIM_NetworkPolicyRule
DescriptionstringReference to the created instance of CIM_NetworkPolicyRule
Outbooleantrue

DeletePolicyRules (uint32)

Method Qualifiers (DeletePolicyRules)

NameData TypeValue
DescriptionstringThis method removes the referenced instances CIM_NetworkPolicyRule and all associated instances of CIM_NetworkPolicyAction, CIM_NetworkPolicyCondition, CIM_NetworkPolicyRuleSettingData, and CIM_NetworkPolicyActionSettingData that are only associated with the rule specified in this method input parameter.

Method Parameters (DeletePolicyRules)

NameTypeQualifiers
NameData TypeValue
NetworkPolicyRuleCIM_NetworkPolicyRule[]
DescriptionstringAn array of referenced instances of CIM_NetworkPolicyRule to be deleted.

ApplyPolicyRule (uint32)

Method Qualifiers (ApplyPolicyRule)

NameData TypeValue
DescriptionstringApplies the Network Policy Rule to the specified instances of the CIM_ManagedElement. This method creates the instances of the CIM_PolicySetAppliesToElement association between the specified instance of the CIM_NetworkPolicyRule and the instances of CIM_ManagedElement subclasses, which references are supplied.

Method Parameters (ApplyPolicyRule)

NameTypeQualifiers
NameData TypeValue
ManagedElememtCIM_ManagedElement[]
DescriptionstringThe managed elements to which to apply the rule
NetworkPolicyRule REF CIM_NetworkPolicyRule
DescriptionstringThe rule to apply

ReleasePolicyRule (uint32)

Method Qualifiers (ReleasePolicyRule)

NameData TypeValue
DescriptionstringRemoves the Network Policy Rule from the ManagedElement instances it was applied before. This method deletes the instances of the CIM_PolicySetAppliesToElement association between the specified instance of the CIM_NetworkPolicyRule and the instances of CIM_ManagedElement subclasses, which references are supplied.

Method Parameters (ReleasePolicyRule)

NameTypeQualifiers
NameData TypeValue
ManagedElementCIM_ManagedElement[]
DescriptionstringThe Manged Elements from which the rule is to be released.
NetworkPolicyRule REF CIM_NetworkPolicyRule
DescriptionstringReference to the rule to be removed

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service