MSFT_NetSARule class
Represents an IPsec Rule. Subtypes differentiate between Connection Security Rules (MSFT_NetConSecRule) and Main Mode Rules (MSFT_NetMainModeRule).
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
class MSFT_NetSARule : CIM_SARule
{
string Platforms[];
string RuleGroup;
string DisplayName;
string DisplayGroup;
uint16 Profiles;
string MainModeCryptoSet;
string QuickModeCryptoSet;
string Phase1AuthSet;
string Phase2AuthSet;
uint16 PrimaryStatus;
uint32 StatusCode;
string Status;
uint16 EnforcementStatus[];
uint16 PolicyStoreSourceType;
string PolicyStoreSource;
};
Members
The MSFT_NetSARule class has these types of members:
Properties
The MSFT_NetSARule class has these properties.
-
DisplayGroup
-
-
Data type: string
-
Access type: Read-only
The group that this rule belongs to. This field is based on the value of RuleGroup and changes to this field are ignored.
-
-
DisplayName
-
-
Data type: string
-
Access type: Read-only
The localized name of this rule. This field's value is based on the value of ElementName. Changes to this field are ignored.
-
-
EnforcementStatus
-
-
Data type: uint16 array
-
Access type: Read-only
If this object is retrieved from the ActiveStore, describes the current enforcement status of the rule.
-
Invalid (0)
-
Full (1)
-
FirewallOffInProfile (2)
-
CategoryOff (3)
-
DisabledObject (4)
-
InactiveProfile (5)
-
LocalAddressResolutionEmpty (6)
-
RemoteAddressResolutionEmpty (7)
-
LocalPortResolutionEmpty (8)
-
RemotePortResolutionEmpty (9)
-
InterfaceResolutionEmpty (10)
-
ApplicationResolutionEmpty (11)
-
RemoteMachineEmpty (12)
-
RemoteUserEmpty (13)
-
LocalGlobalOpenPortsDisallowed (14)
-
LocalAuthorizedApplicationsDisallowed (15)
-
LocalFirewallRulesDisallowed (16)
-
LocalConsecRulesDisallowed (17)
-
NotTargetPlatform (18)
-
OptimizedOut (19)
-
LocalUserEmpty (20)
-
TransportMachinesEmpty (21)
-
TunnelMachinesEmpty (22)
-
TupleResolutionEmpty (23 )
-
-
MainModeCryptoSet
-
-
Data type: string
-
Access type: Read-only
The InstanceID of the MainModeCryptoSet to use for Main Mode.
-
-
Phase1AuthSet
-
-
Data type: string
-
Access type: Read-only
The InstanceID of the Phase1AuthenticationSet to use for Phase 1 auth.
-
-
Phase2AuthSet
-
-
Data type: string
-
Access type: Read-only
The InstanceID of the Phase2AuthenticationSet to use for Phase 2 auth.
-
-
Platforms
-
-
Data type: string array
-
Access type: Read-only
Specifies which platforms the rule is applicable on. If null, the rule applies to all platforms (the default). Each entry takes the form Major.Minor+, for instance 6.0, 6.1+, or 6.2. If + is specified, then it means that the rule applies to that version or greater. For instance, Windows Vista could be represented as 6 or 6.0, and Windows 7 or later would be represented as 6.1+. + may only be attached to the final item in the list. 6.0+ is not valid because it means the same thing as null (all platforms).
-
-
PolicyStoreSource
-
-
Data type: string
-
Access type: Read-only
If this object is retrieved from the ActiveStore, with the TracePolicyStoreSource option set, contains the path to the PolicyStore where this rule originally came from.
-
-
PolicyStoreSourceType
-
-
Data type: uint16
-
Access type: Read-only
If this object is retrieved from the ActiveStore, with the TracePolicyStoreSource option set, describes the type of PolicyStore where this rule originally came from.
-
-
PrimaryStatus
-
-
Data type: uint16
-
Access type: Read-only
PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents. PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "OK" indicates the ManagedElement is functioning normally. "Degraded" indicates the ManagedElement is functioning below normal. "Error" indicates the ManagedElement is in an Error condition.
-
Unknown (0)
-
OK (1)
-
Degraded (2)
-
Error (3)
-
DMTF Reserved (..)
-
Vendor Reserved (0x8000.. )
-
-
Profiles
-
-
Data type: uint16
-
Access type: Read-only
Which profiles this rule is active on.
-
Any (0)
-
Public (0x4)
-
Private (0x2)
-
Domain (0x1 )
-
-
QuickModeCryptoSet
-
-
Data type: string
-
Access type: Read-only
The InstanceID of the QuickModeCryptoSet to use for Quick Mode.
-
-
RuleGroup
-
-
Data type: string
-
Access type: Read-only
The locale-independent name for the group that this rule belongs to. If this field is non-null, then Windows Firewall with Advanced Security assumes that this rule belongs to a Windows component or an installed application, and some parts of the rule are protected (including but not limited to the Name, Description, Program, and Service).
-
-
Status
-
-
Data type: string
-
Access type: Read-only
The detailed status of the rule, as a string.
-
-
StatusCode
-
-
Data type: uint32
-
Access type: Read-only
The detailed status of the rule, as a numeric error code.
-
Requirements
| Minimum supported client |
Windows 8 |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\StandardCimv2 |
| MOF |
|
| DLL |
|