'\" t
.\"     Title: ipmctl-show-socket
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.16
.\"      Date: 2021-12-29
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-SHOW\-SOCKET" "1" "2021-12-29" "ipmctl" "ipmctl"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ipmctl-show-socket \- Shows basic information about the physical processors
.SH "SYNOPSIS"
.sp
.if n .RS 4
.nf
.fam C
ipmctl show [OPTIONS] \-socket [TARGETS]
.fam
.fi
.if n .RE
.SH "DESCRIPTION"
.sp
Shows basic information about the physical processors in the host server.
.SH "OPTIONS"
.sp
\-a, \-all
.RS 4
Shows all attributes.
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
The all and display options are exclusive and may not be used together.
.sp .5v
.RE
.sp
\-d (attributes), \-display (attributes)
.RS 4
Filters the returned attributes by explicitly specifying a comma separated
list of any of the attributes defined in the Return Data section.
.RE
.sp
\-h, \-help
.RS 4
Displays help for the command.
.RE
.sp
\-ddrt
.RS 4
Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.
.RE
.sp
\-smbus
.RS 4
Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
The \-ddrt and \-smbus options are mutually exclusive and may not be used together.
.sp .5v
.RE
.sp
\-o (text|nvmxml), \-output (text|nvmxml)
.RS 4
Changes the output format. One of: "text" (default) or "nvmxml".
.RE
.sp
\-u (B|MB|MiB|GB|GiB|TB| TiB), \-units (B|MB|MiB|GB|GiB|TB| TiB)
.RS 4
Changes the units that capacities are displayed in for this command. One of:
bytes (B), megabytes (MB), mebibytes (MiB), gigabytes (GB), gibibytes (GiB),
terabytes (TB) or tebibytes (TiB).
.RE
.SH "TARGETS"
.sp
\-socket [SocketIDs]
.RS 4
Restricts output to the PMem modules installed on specific sockets by supplying the
socket target and one or more comma separated socket identifiers. The default
is to display all sockets.
.RE
.SH "EXAMPLES"
.sp
Displays information about all the processors.
.sp
.if n .RS 4
.nf
.fam C
ipmctl show \-socket
.fam
.fi
.if n .RE
.sp
Lists all properties for socket 1.
.sp
.if n .RS 4
.nf
.fam C
ipmctl show \-socket 1
.fam
.fi
.if n .RE
.sp
Retrieves specific properties for each processor.
.sp
.if n .RS 4
.nf
.fam C
ipmctl show \-d MappedMemoryLimit \-socket
.fam
.fi
.if n .RE
.SH "RETURN DATA"
.sp
Displays a table with the attributes listed below for each physical processor
installed in the host server.
.sp
SocketID
.RS 4
(Default) The processor socket identifier.
.RE
.sp
MappedMemoryLimit
.RS 4
(Default) The maximum amount of memory that is allowed to be mapped into the
system physical address space for this processor based on its SKU.
.RE
.sp
TotalMappedMemory
.RS 4
(Default) The total amount of memory that is currently mapped into the system
physical address space for this processor.
.RE