AffinityInfo Class

The AffinityInfo object represents the Affinity settings for all CPUs and NUMA nodes on an Instance of SQL Server. Access to the AffinityInfo object is provided though the Server object.


Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

public sealed class AffinityInfo : AffinityInfoBase

The AffinityInfo type exposes the following members.

Public propertyAffinityTypeGets or sets the affinity type of the AffinityInfoBase. (Inherited from AffinityInfoBase.)
Public propertyCpusThe Cpus member is a collection that represents the CPU settings for all CPUs on an Instance of SQL Server.
Public propertyNumaNodesGets a collection that contains the NUMA node settings. (Inherited from AffinityInfoBase.)
Public propertyParentThis gets the parent object of the AffinityInfo object. This value is the same as the Server object that contains the AffinityInfo member.

Public methodAlterUpdates the AffinityInfo object property changes on the instance of SQL Server. (Inherited from AffinityInfoBase.)
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodRefreshThis method fills in the Cpus and NumaNode with the local server settings. (Overrides AffinityInfoBase.Refresh().)
Public methodScript()Generates a Transact-SQL script. (Inherited from AffinityInfoBase.)
Public methodScript(ScriptingOptions)Generates a Transact-SQL script. (Inherited from AffinityInfoBase.)
Public methodToString (Inherited from Object.)

To get AffinityInfo object properties, users can be a member of the public fixed server role.

To set any AffinityInfo object properties and run the Alter method, users must have ALTER permission on the database.

To create a AffinityInfo object, users must have ALTER ANY APPLICATION role permission on the parent database.

To drop an AffinityInfo object, users must be the owner of the application role or have ALTER ANY APPLICATION role permission on the parent database.

To grant, deny, and revoke permission on the AffinityInfo object, users must have CONTROL permission on the application role.

This example shows you how to set all of the CPU’s on an instance of SQL Server to hard affinity.


using System;
using Microsoft.SqlServer.Management.Smo;

namespace samples
    class Program
        static void Main(string[] args)
            Server dbServer = new Server("(local)");
            dbServer.AffinityInfo.AffinityType = AffinityType.Manual;

            foreach (Cpu cpu in dbServer.AffinityInfo.Cpus)
                cpu.AffinityMask = true;



//Create the server. 
$dbServer = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")

//Set the Affinity Type
$dbServer.AffinityInfo.AffinityType = [Microsoft.SqlServer.Management.Smo.AffinityType]'Manual'

//Set each CPU to Hard affinity and update
foreach ($cpu In $dbServer.AffinityInfo.Cpus)
   $cpu.AffinityMask = $True

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions