MSFT_NetFirewallRule, ROOT\StandardCimv2\MS_409

Class | Methods (5) | Properties (36) | Qualifiers (3) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Represents a Windows firewall rule.

MSFT_NetFirewallRule methods

MSFT_NetFirewallRule has 5 methods (5 Local)

NameOriginReturn
CloneObjectMSFT_NetFirewallRuleuint32 {'out':True}
DisableMSFT_NetFirewallRuleuint32 {'out':True}
EnableMSFT_NetFirewallRuleuint32 {'out':True}
EnumerateFullMSFT_NetFirewallRuleuint32 {'out':True}
RenameMSFT_NetFirewallRuleuint32 {'out':True}

MSFT_NetFirewallRule properties

MSFT_NetFirewallRule has 36 properties (17 Local, 19 Derived)

NameOriginCIMType
ActionMSFT_NetFirewallRule18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommonNameCIM_Policy8 [string]
ConditionListTypeCIM_PolicyRule18 [uint16]
key
CreationClassName
CIM_PolicyRule8 [string]
DescriptionCIM_ManagedElement8 [string]
DirectionMSFT_NetFirewallRule18 [uint16]
DisplayGroupMSFT_NetFirewallRule8 [string]
DisplayNameMSFT_NetFirewallRule8 [string]
EdgeTraversalPolicyMSFT_NetFirewallRule18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledCIM_PolicySet18 [uint16]
EnforcementStatusMSFT_NetFirewallRule18 [uint16]
ExecutionStrategyCIM_PolicyRule18 [uint16]
InstanceIDCIM_ManagedElement8 [string]
LocalOnlyMappingMSFT_NetFirewallRule11 [boolean]
LooseSourceMappingMSFT_NetFirewallRule11 [boolean]
MandatoryCIM_PolicyRule11 [boolean]
OwnerMSFT_NetFirewallRule8 [string]
PlatformsMSFT_NetFirewallRule8 [string]
PolicyDecisionStrategyCIM_PolicySet18 [uint16]
PolicyKeywordsCIM_Policy8 [string]
PolicyRolesCIM_PolicySet8 [string]
key
PolicyRuleName
CIM_PolicyRule8 [string]
PolicyStoreSourceMSFT_NetFirewallRule8 [string]
PolicyStoreSourceTypeMSFT_NetFirewallRule18 [uint16]
PrimaryStatusMSFT_NetFirewallRule18 [uint16]
PriorityCIM_PolicyRule18 [uint16]
ProfilesMSFT_NetFirewallRule18 [uint16]
RuleGroupMSFT_NetFirewallRule8 [string]
RuleUsageCIM_PolicyRule8 [string]
SequencedActionsCIM_PolicyRule18 [uint16]
StatusMSFT_NetFirewallRule8 [string]
StatusCodeMSFT_NetFirewallRule19 [uint32]
key
SystemCreationClassName
CIM_PolicyRule8 [string]
key
SystemName
CIM_PolicyRule8 [string]

Detailed description of MSFT_NetFirewallRule methods

Local methods (5) of MSFT_NetFirewallRule class

CloneObject method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
NewNamestring0-{'Description':'The new name for the rule.','In':True}
NewPolicyStorestring1-{'Description':'The new policy store for the rule.','In':True}
NewGPOSessionstring2-{'Description':'The new GPOSession for the rule.','In':True}
Description'Copy this rule.'
CloneObject method is in 7 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
Disable method
Returnuint32 {'out':True}
Description'Disable this rule.'
Disable method is in 20 classes of ROOT\StandardCimv2\MS_409 and in 19 namespaces
Enable method
Returnuint32 {'out':True}
Description'Enable this rule.'
Enable method is in 20 classes of ROOT\StandardCimv2\MS_409 and in 25 namespaces
EnumerateFull method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Dependentsobject:CIM_ManagedSystemElement0-{'Out':True}
Description'Desc'
EnumerateFull method is in 2 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
Rename method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
NewNamestring0-{'Description':'The new name for the rule.','In':True}
Description'Rename this rule.'
Rename method is in 10 classes of ROOT\StandardCimv2\MS_409 and in 12 namespaces

Detailed description of MSFT_NetFirewallRule properties

Local properties (17) of MSFT_NetFirewallRule class

Action property
CIMTYPE'uint16'
Description'Specifies the action to take on traffic that matches this rule.'
Values['Allow', 'AllowBypass', 'Block']
Action property is in 2 classes of ROOT\StandardCimv2\MS_409 and in 13 namespaces
Direction property
CIMTYPE'uint16'
Description'Specifies which direction of traffic to match with this rule.'
Values['Inbound', 'Outbound']
Direction property is in 1 class (MSFT_NetFirewallRule) of ROOT\StandardCimv2\MS_409 and in 9 namespaces
DisplayGroup property
CIMTYPE'string'
Description'The group that this rule belongs to. This field is based on the value of RuleGroup and changes to this field are ignored.'
DisplayGroup property is in 10 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
DisplayName property
CIMTYPE'string'
Description'The localized name of this rule. This field's value is based on the value of ElementName. Changes to this field are ignored.'
DisplayName property is in 12 classes of ROOT\StandardCimv2\MS_409 and in 30 namespaces
EdgeTraversalPolicy property
CIMTYPE'uint16'
Description'Specifies how this firewall rule will handle edge traversal cases.'
Values['Block', 'Allow', 'Defer to User', 'Defer to App']
EdgeTraversalPolicy property is in 1 class (MSFT_NetFirewallRule) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
EnforcementStatus property
CIMTYPE'uint16'
Description'If this object is retrieved from the ActiveStore, describes the current enforcement status of the rule.'
Values['Invalid', 'Full', 'FirewallOffInProfile', 'CategoryOff', 'DisabledObject', 'InactiveProfile', 'LocalAddressResolutionEmpty', 'RemoteAddressResolutionEmpty', 'LocalPortResolutionEmpty', 'RemotePortResolutionEmpty', 'InterfaceResolutionEmpty', 'ApplicationResolutionEmpty', 'RemoteMachineEmpty', 'RemoteUserEmpty', 'LocalGlobalOpenPortsDisallowed', 'LocalAuthorizedApplicationsDisallowed', 'LocalFirewallRulesDisallowed', 'LocalConsecRulesDisallowed', 'NotTargetPlatform', 'OptimizedOut', 'LocalUserEmpty', 'TransportMachinesEmpty', 'TunnelMachinesEmpty', 'TupleResolutionEmpty']
EnforcementStatus property is in 10 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
LocalOnlyMapping property
CIMTYPE'boolean'
Description'Whether to group UDP packets into conversations based only upon the local address and port. Applies only to UDP.'
LocalOnlyMapping property is in 1 class (MSFT_NetFirewallRule) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
LooseSourceMapping property
CIMTYPE'boolean'
Description'Whether to group UDP packets into conversations based upon the local address, local port, and remote port. Applies only to UDP.'
LooseSourceMapping property is in 1 class (MSFT_NetFirewallRule) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
Owner property
CIMTYPE'string'
Description'The owner of the firewall rule, as a SID.'
Owner property is in 5 classes of ROOT\StandardCimv2\MS_409 and in 142 namespaces
Platforms property
CIMTYPE'string'
Description'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).'
Platforms property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyStoreSource property
CIMTYPE'string'
Description'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.'
PolicyStoreSource property is in 10 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyStoreSourceType property
CIMTYPE'uint16'
Description'If this object is retrieved from the ActiveStore, with the TracePolicyStoreSource option set, describes the type of PolicyStore where this rule originally came from.'
PolicyStoreSourceType property is in 10 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PrimaryStatus property
CIMTYPE'uint16'
Description'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.
'
Values['Unknown', 'OK', 'Degraded', 'Error', 'DMTF Reserved', 'Vendor Reserved']
PrimaryStatus property is in 71 classes of ROOT\StandardCimv2\MS_409 and in 9 namespaces
Profiles property
CIMTYPE'uint16'
Description'Which profiles this rule is active on.'
Values['Any', 'Public', 'Private', 'Domain']
Profiles property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 4 namespaces
RuleGroup property
CIMTYPE'string'
Description'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).'
RuleGroup property is in 10 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
Status property
CIMTYPE'string'
Description'The detailed status of the rule, as a string.'
Status property is in 72 classes of ROOT\StandardCimv2\MS_409 and in 42 namespaces
StatusCode property
CIMTYPE'uint32'
Description'The detailed status of the rule, as a numeric error code.'
StatusCode property is in 12 classes of ROOT\StandardCimv2\MS_409 and in 142 namespaces

Derived properties (19) of MSFT_NetFirewallRule class

Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
Caption property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 37 namespaces
CommonName property
CIMTYPE'string'
Description'This field is ignored.'
CommonName property is in 20 classes of ROOT\StandardCimv2\MS_409 and in 5 namespaces
ConditionListType property
CIMTYPE'uint16'
Description'This field is ignored.'
Values['Unconditional Rule', 'DNF', 'CNF']
ConditionListType property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
CreationClassName property
CIMTYPE'string'
Description'Reserved for internal use by the WMI provider only.'
keyTrue
CreationClassName property is in 47 classes of ROOT\StandardCimv2\MS_409 and in 20 namespaces
Description property
CIMTYPE'string'
Description'A brief description of the rule. May be an indirect string. If it is an indirect string, then it may not be overwritten.'
Description property is in 154 classes of ROOT\StandardCimv2\MS_409 and in 142 namespaces
ElementName property
CIMTYPE'string'
Description'The locale-independent name of the rule. May be an indirect string.'
ElementName property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 21 namespaces
Enabled property
CIMTYPE'uint16'
Description'Indicates whether this rule is administratively enabled or disabled.'
Values['Enabled', 'Disabled']
Enabled property is in 15 classes of ROOT\StandardCimv2\MS_409 and in 142 namespaces
ExecutionStrategy property
CIMTYPE'uint16'
Description'This field is ignored.'
Values['Do Until Success', 'Do All', 'Do Until Failure']
ExecutionStrategy property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
InstanceID property
CIMTYPE'string'
Description'A string that uniquely identifies this instance within the PolicyStore.'
InstanceID property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 21 namespaces
Mandatory property
CIMTYPE'boolean'
Description'This field is ignored.'
Mandatory property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyDecisionStrategy property
CIMTYPE'uint16'
Description'This field is ignored.'
Values['First Matching', 'All']
PolicyDecisionStrategy property is in 7 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyKeywords property
CIMTYPE'string'
Description'This field is ignored.'
PolicyKeywords property is in 20 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyRoles property
CIMTYPE'string'
Description'This field is ignored.'
PolicyRoles property is in 7 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyRuleName property
CIMTYPE'string'
Description'Reserved for internal use by the WMI provider only.'
keyTrue
PolicyRuleName property is in 18 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
Priority property
CIMTYPE'uint16'
Description'This field is ignored.'
Priority property is in 28 classes of ROOT\StandardCimv2\MS_409 and in 31 namespaces
RuleUsage property
CIMTYPE'string'
Description'This field is ignored.'
RuleUsage property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
SequencedActions property
CIMTYPE'uint16'
Description'This field is ignored.'
Values['Mandatory', 'Recommended', 'Dont Care']
SequencedActions property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
SystemCreationClassName property
CIMTYPE'string'
Description'Reserved for internal use by the WMI provider only.'
keyTrue
SystemCreationClassName property is in 47 classes of ROOT\StandardCimv2\MS_409 and in 20 namespaces
SystemName property
CIMTYPE'string'
Description'Reserved for internal use by the WMI provider only.'
keyTrue
SystemName property is in 66 classes of ROOT\StandardCimv2\MS_409 and in 22 namespaces

MSFT_NetFirewallRule Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'Represents a Windows firewall rule.'
LOCALE'MS_409'

MSFT_NetFirewallRule System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\StandardCimv2\MS_409:MSFT_NetFirewallRule'___SYSTEM8
__NAMESPACE'ROOT\StandardCimv2\MS_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_PolicyRule', 'CIM_PolicySet', 'CIM_Policy', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT36___SYSTEM3
__RELPATH'MSFT_NetFirewallRule'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_PolicyRule'___SYSTEM8
__CLASS'MSFT_NetFirewallRule'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSFT_NetFirewallRule

Number of classes:36
comments powered by Disqus
WUtils.com