Oracle® Solaris Cluster 参考手册

退出打印视图

更新时间: 2014 年 7 月,E51743-01
 
 

clpstring (1CL)

名称

clpstring, clps - 管理 Oracle Solaris Cluster 专用字符串

用法概要

/usr/cluster/bin/clpstring -V
/usr/cluster/bin/clpstring subcommand -?
/usr/cluster/bin/clpstring subcommand [options] -v [pstring-name[...]
/usr/cluster/bin/clpstring create -b object-instance [-f 
     stringvalue-file] [-t object-type] [-Z {zoneclustername | global}] 
     pstring-name
/usr/cluster/bin/clpstring delete [-F] [-Z {zoneclustername[,...] | 
     global | all}] + | pstring-name ...
/usr/cluster/bin/clpstring list [-b object-instance[,...]] [-t 
     type[,...]] [-Z {zoneclustername[,...] | global | all}] [+ | 
     pstring-name[...]]
/usr/cluster/bin/clpstring set [-f stringvalue-file] [-Z 
     {zoneclustername | global}] pstring-name
/usr/cluster/bin/clpstring show [-b object-instance[,...]] [-t 
     type[,...]] [-Z {zoneclustername[,...] | global | all}] [+ | 
     pstring-name[...]]

描述

clpstring 命令管理 Oracle Solaris Cluster 专用字符串。专用字符串使用唯一名称进行标识,其具有的编码值只能使用 scha_cluster_get(1HA) 命令获取。

群集对象(例如资源)使用专用字符串来安全地存储和检索专用值。一个典型的应用可能是代理使用的内部密码。

clps 命令是 clpstring 命令的简短格式。clpstring 命令和 clps 命令是相同的。您可以使用此命令的任一种格式。

此命令的一般格式如下所示:

clpstring [subcommand] [options] [operands]

仅当 options 指定 –? 选项或 –V 选项时,才可以省略 subcommand

此命令的每个选项都有长格式和简短格式两种格式。在本手册页的 选项 部分给出了每个选项的两种格式,以及对该选项的描述。

    使用 clpstring 命令执行以下管理任务:

  • 创建要由可能存在也可能尚不存在的群集对象实例使用的专用字符串

  • 更新专用字符串的值

  • 从群集配置中删除专用字符串

  • 显示专用字符串的指定信息

只能在活动群集节点上运行 clpstring 命令。无论您在哪个节点上运行该命令,运行结果始终相同。

clpstring 命令的所有子命令都可以在全局区域和区域群集中运行。在全局区域中运行该命令时,可以使用 –Z 选项指定要将操作限制到的特定区域群集的名称。

您可以从全局群集节点访问所有区域群集信息,但无法从特定区域群集访问其他区域群集信息。如果不将操作限制到特定区域群集,则所用的子命令仅会在当前群集中运行。

子命令

支持以下子命令:

create

创建要由 Oracle Solaris Cluster 对象实例使用的专用字符串。

使用 -b 选项可指定要使用此专用字符串的群集对象实例。在为实例创建专用字符串时,对象实例不必存在于群集配置中。使用 -t 选项可指示群集对象实例的类型。默认对象类型为 resource

使用 -f 选项可指定包含专用字符串值的文件。如果未指定 -f,该命令将会提示您提供专用字符串值。可以在“选项”部分中找到详细信息。

超级用户以外的用户需要具有 solaris.cluster.modify 基于角色的访问控制 (role-based access control, RBAC) 授权才能使用 create 子命令。有关更多信息,请参见 rbac(5) 手册页。

另请参见 delete 子命令的描述。

delete

从 Oracle Solaris Cluster 配置中删除指定的专用字符串。

如果不指定强制选项 -F,则必须已删除了为其创建专用字符串的群集对象实例。如果指定了 -F 选项,该命令将强制删除专用字符串,即使关联的对象实例仍存在于群集配置中并在使用该专用字符串也是如此。有关更多信息,请参见“选项”中的 -F

超级用户以外的用户需要具有 solaris.cluster.modify RBAC 授权才能使用 delete 子命令。

另请参见 create 子命令的描述。

list

显示在群集中创建的所有专用字符串的名称,但不显示它们的值。

超级用户以外的用户需要具有 solaris.cluster.read RBAC 授权才能使用该子命令。

set

设置指定专用字符串的值。可以使用 -f 选项指定专用字符串值的源。如果未指定 -f,该命令将会提示您提供相应的值。有关专用字符串值的信息,请参见“选项”部分中的 -f 选项描述。

超级用户以外的用户需要具有 solaris.cluster.modify RBAC 授权才能使用该子命令。

show

显示专用字符串的指定信息,但不显示它们的值。指定信息包括专用字符串名称、其关联的对象实例以及实例的对象类型。

超级用户以外的用户需要具有 solaris.cluster.read RBAC 授权才能使用该子命令。

选项

支持以下选项:

–?
–-help

显示帮助信息。使用该选项时,不会执行任何其他处理。

指定此选项时,子命令可有可无。

如果仅指定此选项而不使用子命令,将会显示此命令的子命令列表。

如果使用子命令且指定此选项,将会显示该子命令的用法选项。

–b object-instance
–-object-instance=object-instance
–-object-instance object-instance

指定使用或将要使用专用字符串的对象实例的名称。当前仅支持对象类型为 resource 的对象实例。

–F
–-force

强制删除指定的专用字符串。此选项仅可以与 delete 子命令一同指定。

将此选项与 delete 子命令一起使用时,将删除指定的专用字符串,即使使用专用字符串的对象实例仍存在于群集中也是如此。通常应先从群集中删除对象实例,然后再删除其专用字符串。

–f stringvalue-file
–-stringvalue-file=stringvalue-file
–-stringvalue-file stringvalue-file

指定包含专用字符串值的文件。文件名必须是可从运行该命令的节点访问的完整路径。

为安全起见,无法在命令行选项中指定专用字符串值。为了确保值安全,请将其置于纯文本文件中并通过使用 –f 选项指定该文件的完整路径。将字符串值文件的所有者设置为 root,并将文件的权限设置为可由 root 读取并禁止任何组访问和全局访问。要进一步提高安全性,可以在运行设置专用字符串值的命令之后删除该文件。

如果不指定 –f 选项,该命令将会提示您输入专用字符串值两次,以确认输入内容相同。该命令将从控制终端读取相应的值,同时禁用回显。

可以指定 –f -–f 后跟一个空格和短划线)以直接从标准输入只读取一次专用字符串值。专用字符串值在键入时会回显在屏幕上,如果该命令用于编写脚本,专用字符串值会显示在脚本中;因此以该方式设置专用字符串值时应小心。

    专用字符串值输入具有以下要求:

  • 字符串长度不得超过 257 个字符。

  • 字符串中不能包含 NULL 字符。

–t object-type
–-object-type=object-type
–-object-type object-type

指定对象实例的类型。默认类型为 resource,该类型是当前唯一可使用专用字符串的对象类型,因此不需要 –t 选项。

–V
–-version

显示该命令的版本。

指定此选项时,不要将其与子命令、操作数或其他选项结合使用。子命令、操作数或其他选项将被忽略。–V 选项只显示命令的版本。不会执行任何其他操作。

–v
–-verbose

将详细消息显示到标准输出。

可以在任何格式的此命令中指定该选项。

–Z {zoneclustername | global | all}
–-zoneclustername={zoneclustername | global | all}

指定要在其中创建专用字符串的群集或专用字符串所位于的群集。

所有子命令都支持该选项。

如果指定此选项,还必须指定以下列表中的参数之一:

zoneclustername

指定使用此选项的命令仅对名为 zoneclustername 的区域群集中的所有指定专用字符串起作用。

global

指定使用此选项的命令仅对全局群集中的所有指定专用字符串起作用。

all

如果在全局群集中使用此参数,则会指定使用此参数的命令对所有群集(包括全局群集和所有区域群集)中的所有指定资源起作用。

操作数

仅支持以下操作数:

pstring-name

指定专用字符串的名称。创建专用字符串时,指定的名称在群集中必须是唯一的。如果子命令接受多个专用字符串,则可以使用加号 (+) 替代 pstring-name 来指定所有专用字符串。

退出状态

如果命令对于所有指定的操作数均成功执行,则返回零 (CL_NOERR)。如果某个操作数出错,命令会继续处理操作数列表中的下一个操作数。返回的退出代码始终反映最先发生的错误。

可返回下列退出代码:

0 CL_NOERR

没有错误

您发出的命令已成功完成。

1 CL_ENOMEM

交换空间不足

某个群集节点耗尽了交换内存或其他操作系统资源。

3 CL_EINVAL

参数无效

您键入的命令不正确,或者使用 –i 选项提供的群集配置信息语法不正确。

6 CL_EACCESS

权限被拒绝

指定的对象不可访问。要发出命令,可能需要拥有超级用户或 RBAC 访问权限。有关更多信息,请参见 su(1M)rbac(5) 手册页。

18 CL_EINTERNAL

遇到内部错误

内部错误表示软件缺陷或其他缺陷。

36 CL_ENOENT

没有这样的对象

由于以下某个原因,找不到您所指定的对象:

  • 该对象不存在。

  • 您尝试使用 –o 选项创建的配置文件路径中的某个目录不存在。

  • 您尝试使用 –i 选项访问的配置文件包含错误。

37 CL_EOP

不允许操作

您尝试对不受支持的配置执行操作,或者您所执行的操作不受支持。

39 CL_EEXIST

对象已存在

您所指定的设备、设备组、群集互连组件、节点、群集、资源、资源类型、资源组或专用字符串已存在。

41 CL_ETYPE

类型无效

您使用 –t–p 选项指定的类型不存在。

这些退出值与 scha_calls(3HA) 手册页中描述的返回码兼容。

示例

示例 1 为全局群集或区域群集中的资源创建专用字符串

以下命令为全局群集中的资源实例创建专用字符串。

# clpstring create -b resource1 -t resource -v pstring1
Enter string value: 
Enter string value again: 
Private string "pstring1" is created for the global cluster.

以下命令在全局区域中运行并为名为 zc1 的区域群集创建专用字符串。专用字符串的值是在 /pvalue.file 文件中指定的。

# clpstring create -Z zc1 -b resource2 -f /pvalue.file pstring2
示例 2 从全局群集或区域群集配置中删除专用字符串

以下命令将从群集配置中删除所有专用字符串,无论对象实例是否仍存在于群集中。

# clpstring delete -F +

以下命令从名为 zc1 的区域群集中删除指定的专用字符串。

# clpstring delete -Z zc1 pstring1
示例 3 显示在群集中创建的专用字符串的指定信息

以下命令显示群集中的专用字符串。

# clpstring show
=== Private Strings ===                        

Pstring Name:                                   pstring1
  Object Instance:                                 resource1
  Object Type:                                     resource

Pstring Name:                                   pstring2
  Object Instance:                                 object2
  Object Type:                                     resource

示例 4 列出全局群集和区域群集中的专用字符串

以下命令显示全局群集和所有区域群集中的专用字符串名称。

# clpstring list -Z all
global:pstring1
global:pstring2
zc1:pstring1
zc1:pstring2
zc2:pstring

属性

有关以下属性的描述,请参见 attributes(5)

属性类型
属性值
可用性
ha-cluster/system/core
接口稳定性
Evolving(发展中)

另请参见

Intro(1CL)cluster(1CL)scha_calls(3HA)attributes(5)rbac(5)

附注

超级用户可以运行此命令的所有格式。

任何用户都可以运行带有以下选项的此命令:

  • –? 选项

  • –V 选项

要运行带有子命令的此命令,超级用户以外的用户需要具有 RBAC 授权。请参见下表。

子命令
RBAC 授权
create
solaris.cluster.modify
delete
solaris.cluster.modify
list
solaris.cluster.read
set
solaris.cluster.modify
show
solaris.cluster.read