mmsclient(1m)

1mmsclient(1M)           System Administration Commands           mmsclient(1M)
2
3
4

NAME

6       mmsclient - send script commands to Media Management server
7

SYNOPSIS

9       /usr/bin/mmsclient [-f filename] [-A application-name] [-c clientname]
10            [-i instancename] [-n network_config_file] [-P password]
11            [-p portnumber] [-s hostname:port] [-t tag]
12
13
14       /usr/bin/mmsclient -h
15
16

DESCRIPTION

18       The  mmsclient  command  creates a session with a Media Management (MM)
19       server, enabling you to send Media Management Protocol  (MMP)  commands
20       to  the  server  and receive responses from that server. When used with
21       the -f option (see below), mmsclient runs a script file  that  performs
22       MMP operations. See mmsclient_script(4) for a description of the script
23       file.
24
25
26       The MMP and the commands in the script file are based, in part, on IEEE
27       1244, the Media Management System (MMS) standards.
28
29
30       To  run  mmsclient,  you  must  become superuser, or assume the Primary
31       Administrator role.
32

OPTIONS

34       The following options are supported:
35
36       -A application-name
37
38           Specifies the MMS application name to use for the current  session.
39           The default application name is MMS.
40
41
42       -c client-name
43
44           Specifies  the  MMS  client from which commands are sent to the MMS
45           server. The default is localhost. Note that this is  not  the  host
46           name for the MMS, which you specify with the -s option (see below).
47
48
49       -f filename
50
51           Specifies  the  name  of  the file containing the MMP commands. See
52           mmsclient_script(4) for a description of the script file.
53
54
55       -h
56
57           Display usage information.
58
59
60       -i instance-name
61
62           Specifies the MMS application instance to use for this session.  If
63           administrative  tasks  such  as  creating  or  deleting objects are
64           planned for the session, specify the instance as Admin.
65
66
67       -n network_config_file
68
69           Defines the configuration for the application client that runs  the
70           script, including the default values. To run the script of MMP com‐
71           mands, the application client can be configured explicitly, can use
72           the default values, or can be modified using the values in this XML
73           file. See EXAMPLES.
74
75
76       -P password-file
77
78           Specifies the full path to a file containing the password  for  the
79           application  specified  with the -A option. If the command does not
80           contain the -P option, you are prompted for the password. There  is
81           no default.
82
83
84       -p portnumber
85
86           Specify port number of MMS server.
87
88
89       -s hostname[:port]
90
91           Specifies the MMS server and, optionally, the port number, to which
92           you send MMP commands. If you do not specify port, the port  number
93           defaults to 7151.
94
95
96       -t tag
97
98           Specify a tag for identifying an MMS session. You can match against
99           tag to query information related to a session. The default  tag  is
100           mmsclient-pid=pid, where pid is the PID of the MMS client.
101
102

EXAMPLES

104       Example 1 Example of a Network Configuration File
105
106
107       The  following  example  configuration file, net_cfg.xml, specifies the
108       conditions under which the MMP commands are performed:
109
110
111         <!-- Client Configuration -->
112         <mms_cfg>
113              <!-- Network Configuration -->
114              <mms_network_cfg
115                         host = "localhost"
116                         port = "7151"
117                         name = "MMS"
118                         instance = "admin"
119                         language = "MMP"
120                         version = "1.0"
121                         password = "summer05"
122                         <!-- mm_password = "MMS Media Manager" -->
123                         ssl_enabled = "false"
124                         ssl_cert_file = "/var/mms/ssl/pub/mms.pem"
125                         ssl_pass_file = "/var/mms/ssl/pub/mms_pass"
126                         <!-- ssl_crl_file = "/var/mms/ssl/pub/mms_crl.pem" -->
127                 />
128         </mms_cfg>
129
130
131
132       Example 2 Running a Script with Default Connections
133
134
135       The following command  runs  a  script  named  test_beginend  with  the
136       default connections:
137
138
139         # mmsclient -f test_beginend
140
141
142
143       Example 3 Specifying a Client by Host Name and Port Number
144
145
146       The  following  command runs a script named test_beginend that connects
147       to an MMS server on a host named x4200 and port number 1492 as the  HSM
148       admin:
149
150
151         # mmsclient -f test_beginend -A HSM -i admin -t HSM_test_session \
152         -s x4200:1492
153
154
155
156       Example 4 Using a Network Configuration File and Specifying an Interac‐
157       tive Session
158
159
160       The following command  connects  to  the  MMS  server  defined  in  the
161       net_cfg.xml file and runs an interactive session:
162
163
164         # mmsclient -n net_cfg.xml
165
166
167

EXIT STATUS

169       0
170
171           Success.
172
173
174       !=0
175
176           An error occurred.
177
178

ATTRIBUTES

180       See attributes(5) for descriptions of the following attributes:
181
182
183
184
185       ┌─────────────────────────────┬─────────────────────────────┐
186       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
187       ├─────────────────────────────┼─────────────────────────────┤
188       │Availability                 │SUNWmmsu                     │
189       ├─────────────────────────────┼─────────────────────────────┤
190       │Interface Stability          │Volatile                     │
191       └─────────────────────────────┴─────────────────────────────┘
192