1 '\" te |
1 '\" te |
2 .\" Copyright (c) 2011, 2012, Oracle and/or its |
2 .\" Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved. |
3 .\" affiliates. All rights reserved. |
|
4 .TH js2ai 1M "20 Feb 2012" "SunOS 5.11" "System Administration Commands" |
3 .TH js2ai 1M "20 Feb 2012" "SunOS 5.11" "System Administration Commands" |
5 .SH NAME |
4 .SH NAME |
6 js2ai \- Translate JumpStart rules and profiles for use with the Automated Installer (AI). |
5 js2ai \- Translate JumpStart rules and profiles for use with the Automated Installer (AI). |
7 .SH SYNOPSIS |
6 .SH SYNOPSIS |
8 .LP |
7 .LP |
10 js2ai [-h | --version] |
9 js2ai [-h | --version] |
11 .fi |
10 .fi |
12 |
11 |
13 .LP |
12 .LP |
14 .nf |
13 .nf |
15 js2ai -r | -p \fIprofile_name\fR [-d \fIjumpstart_dir\fR] |
14 js2ai -r | -p \fIprofile\fR [-d \fIjsdir\fR] |
16 [-D \fIdestination_dir\fR] [-lSv] |
15 [-D \fIdestdir\fR] [-lSv] |
17 .fi |
16 .fi |
18 |
17 |
19 .LP |
18 .LP |
20 .nf |
19 .nf |
21 js2ai -s [-d \fIjumpstart_dir\fR] |
20 js2ai -s [-d \fIjsdir\fR] |
22 [-D \fIdestination_dir\fR] [-Sv] |
21 [-D \fIdestdir\fR] [-Sv] |
23 .fi |
22 .fi |
24 |
23 |
25 .LP |
24 .LP |
26 .nf |
25 .nf |
27 js2ai -V \fImanifest\fR |
26 js2ai -V \fImanifest\fR |
182 T} |
181 T} |
183 4T{ |
182 4T{ |
184 If \fBrootdisk\fR is not set and a \fBfilesys \fIcwtxdysz\fR \fIsize\fR /\fR entry is specified in the profile, \fBjs2ai\fR sets \fBrootdisk\fR to the \fIcwtxdysz\fR disk specified in the entry. |
183 If \fBrootdisk\fR is not set and a \fBfilesys \fIcwtxdysz\fR \fIsize\fR /\fR entry is specified in the profile, \fBjs2ai\fR sets \fBrootdisk\fR to the \fIcwtxdysz\fR disk specified in the entry. |
185 T} |
184 T} |
186 5T{ |
185 5T{ |
187 If \fBrootdisk\fR is not set and a \fBusedisk \fIdisk_name\fR\fR entry is specified in the profile, \fBjs2ai\fR sets \fBrootdisk\fR to the \fIdisk_name\fR disk specified in the entry. |
186 If \fBrootdisk\fR is not set and a \fBusedisk \fIdisk\fR\fR entry is specified in the profile, \fBjs2ai\fR sets \fBrootdisk\fR to the \fIdisk\fR disk specified in the entry. |
188 T} |
187 T} |
189 6T{ |
188 6T{ |
190 If \fBrootdisk\fR is not set and the following specification is encountered in the profile where \fIsize\fR is not 0 or \fBdelete\fR and \fIdisk_name\fR is not \fBall\fR, then \fBrootdisk\fR is set to this \fIdisk_name\fR. |
189 If \fBrootdisk\fR is not set and the following specification is encountered in the profile where \fIsize\fR is not 0 or \fBdelete\fR and \fIdisk\fR is not \fBall\fR, then \fBrootdisk\fR is set to this \fIdisk\fR name. |
191 .sp |
190 .sp |
192 .in +2 |
191 .in +2 |
193 .nf |
192 .nf |
194 fdisk \fIdisk_name\fR solaris \fIsize\fR |
193 fdisk \fIdisk\fR solaris \fIsize\fR |
195 .fi |
194 .fi |
196 .in -2 |
195 .in -2 |
197 |
196 |
198 T} |
197 T} |
199 7T{ |
198 7T{ |
280 T} |
279 T} |
281 \fBname_service\fRT{ |
280 \fBname_service\fRT{ |
282 Supports values \fBNone\fR, \fBDNS\fR, \fBNIS\fR, and \fBLDAP\fR. NIS+ name services are translated as NIS. If a name service is specified, the network interface in Oracle Solaris 11 is configured for \fBDefaultFixed\fR. The \fBnetwork_interface\fR keyword can be used to define the characteristics of the network. |
281 Supports values \fBNone\fR, \fBDNS\fR, \fBNIS\fR, and \fBLDAP\fR. NIS+ name services are translated as NIS. If a name service is specified, the network interface in Oracle Solaris 11 is configured for \fBDefaultFixed\fR. The \fBnetwork_interface\fR keyword can be used to define the characteristics of the network. |
283 T} |
282 T} |
284 \fBnetwork_interface\fRT{ |
283 \fBnetwork_interface\fRT{ |
285 AI supports configuring only a single interface as part of system installation. Because of this limitation, the \fBjs2ai\fR tool processes only the interface labeled \fBPRIMARY\fR or the first interface encountered in the \fBsysidcfg\fR file. If a \fBname_service\fR is specified, the network is configured as \fBDefaultFixed\fR. A properly configured \fBDefaultFixed\fR network needs to provide the host name, IP address, netmask, and gateway. Automated network configuration is only supported if no name service is specified. |
284 AI supports configuring only a single interface as part of system installation. Because of this limitation, the \fBjs2ai\fR tool processes only the interface labeled \fBPRIMARY\fR or the first interface encountered in the \fBsysidcfg\fR file. If a \fBname_service\fR is specified, the network is configured as \fBDefaultFixed\fR. A properly configured \fBDefaultFixed\fR network needs to provide the host name, IP address, netmask, and gateway. Automated network configuration is only supported if no name service is specified. |
286 T} |
285 T} |
287 \fBroot_password\fRNo translation is necessary. |
286 \fBroot_password\fRNo translation is necessary. |
288 \fBsecurity_policy\fRSupports value: \fBNone\fR |
287 \fBsecurity_policy\fRSupports value: \fBNone\fR |
289 \fBservice_profile\fRSupports value: \fBlimited_net\fR |
288 \fBservice_profile\fRSupports value: \fBlimited_net\fR |
290 \fBsystem_locale\fRT{ |
289 \fBsystem_locale\fRT{ |
335 |
334 |
336 .sp |
335 .sp |
337 .ne 2 |
336 .ne 2 |
338 .mk |
337 .mk |
339 .na |
338 .na |
340 \fB\fB-d\fR \fIjumpstart_dir\fR, \fB--dir\fR \fIjumpstart_dir\fR\fR |
339 \fB\fB-d\fR \fIjsdir\fR, \fB--dir\fR \fIjsdir\fR\fR |
341 .ad |
340 .ad |
342 .sp .6 |
341 .sp .6 |
343 .RS 4n |
342 .RS 4n |
344 Specify the location of the \fBrules\fR and profile files or the \fBsysidcfg\fR file. |
343 Specify the location of the \fBrules\fR and profile files or the \fBsysidcfg\fR file. |
345 .RE |
344 .RE |
346 |
345 |
347 .sp |
346 .sp |
348 .ne 2 |
347 .ne 2 |
349 .mk |
348 .mk |
350 .na |
349 .na |
351 \fB\fB-D\fR \fIdestination_dir\fR, \fB--dest\fR \fIdestination_dir\fR\fR |
350 \fB\fB-D\fR \fIdestdir\fR, \fB--dest\fR \fIdestdir\fR\fR |
352 .ad |
351 .ad |
353 .sp .6 |
352 .sp .6 |
354 .RS 4n |
353 .RS 4n |
355 Specify the location for the output files. |
354 Specify the location for the output files. |
356 .RE |
355 .RE |
571 # \fBjs2ai -rS\fR |
570 # \fBjs2ai -rS\fR |
572 .fi |
571 .fi |
573 .in -2 |
572 .in -2 |
574 .sp |
573 .sp |
575 |
574 |
576 This command performs a conversion operation on the \fBrules\fR file and the profiles referenced by the \fBrules\fR file. Each profile referenced in the \fBrules\fR file is processed against the AI client provisioning manifest, \fB/usr/share/auto_install/manifest/default.xml\fR. This step creates a directory named \fBAI_\fIprofile_name\fR\fR for each profile specified in the JumpStart \fBrules\fR file. The \fBAI_\fIprofile_name\fR\fR directory contains one or more AI manifests for the translated profile in the form \fB\fIprofile_name\fR${arch}.xml\fR. See the "Files" section for more information. |
575 This command performs a conversion operation on the \fBrules\fR file and the profiles referenced by the \fBrules\fR file. Each profile referenced in the \fBrules\fR file is processed against the AI client provisioning manifest, \fB/usr/share/auto_install/manifest/default.xml\fR. This step creates a directory named \fBAI_\fIprofile\fR\fR for each profile specified in the JumpStart \fBrules\fR file. The \fBAI_\fIprofile\fR\fR directory contains one or more AI manifests for the translated profile in the form \fB\fIprofile\fR${arch}.xml\fR. See the "Files" section for more information. |
577 .sp |
576 .sp |
578 The \fB-S\fR option skips the validation sequence. Validation is done in step 5. |
577 The \fB-S\fR option skips the validation sequence. Validation is done in step 5. |
579 .RE |
578 .RE |
580 .RS +4 |
579 .RS +4 |
581 .TP |
580 .TP |
582 4. |
581 4. |
583 If the message "Successfully completed conversion" is output, skip to step 5. Otherwise, examine the \fBjs2ai.log\fR file and follow these steps: |
582 If the message "Successfully completed conversion" is output, skip to step 5. Otherwise, examine the \fBjs2ai.log\fR file and follow these steps: |
584 .RS +4 |
583 .RS +4 |
585 .TP |
584 .TP |
586 a. |
585 a. |
587 Correct any process errors. |
586 Correct any process errors. |
588 .RE |
587 .RE |
628 .sp |
627 .sp |
629 For each \fBsysidcfg\fR file, execute the following command: |
628 For each \fBsysidcfg\fR file, execute the following command: |
630 .sp |
629 .sp |
631 .in +2 |
630 .in +2 |
632 .nf |
631 .nf |
633 # \fBjs2ai -sS -d \fIsysidcfg_dir\fR\fR |
632 # \fBjs2ai -sS -d \fIsysidcfgdir\fR\fR |
634 .fi |
633 .fi |
635 .in -2 |
634 .in -2 |
636 .sp |
635 .sp |
637 |
636 |
638 For each \fBsysidcfg\fR file processed, this step creates an AI system configuration profile file named \fBsc_profile.xml\fR in the directory where the \fBjs2ai\fR command was invoked. Use the \fB-D\fR option to specify a different directory for the \fBsc_profile.xml\fR file. |
637 For each \fBsysidcfg\fR file processed, this step creates an AI system configuration profile file named \fBsc_profile.xml\fR in the directory where the \fBjs2ai\fR command was invoked. Use the \fB-D\fR option to specify a different directory for the \fBsc_profile.xml\fR file. |
672 8. |
671 8. |
673 Rerun \fBjs2ai\fR without the \fB-S\fR option. |
672 Rerun \fBjs2ai\fR without the \fB-S\fR option. |
674 .sp |
673 .sp |
675 .in +2 |
674 .in +2 |
676 .nf |
675 .nf |
677 # \fBjs2ai -s -d \fIsysidcfg_dir\fR\fR |
676 # \fBjs2ai -s -d \fIsysidcfgdir\fR\fR |
678 .fi |
677 .fi |
679 .in -2 |
678 .in -2 |
680 .sp |
679 .sp |
681 |
680 |
682 If any validation errors occur for any of the processed \fBsysidcfg\fR files, the resulting AI system configuration profile must be manually corrected. Examine the \fBjs2ai.log\fR file for details of the failure. See the AI documentation for information about system configuration profiles. |
681 If any validation errors occur for any of the processed \fBsysidcfg\fR files, the resulting AI system configuration profile must be manually corrected. Examine the \fBjs2ai.log\fR file for details of the failure. See the AI documentation for information about system configuration profiles. |
693 .sp |
692 .sp |
694 Use the \fBinstalladm\fR command with the \fBcreate-manifest\fR subcommand to add each AI manifest with criteria for selecting that manifest. Each client can use only one AI manifest. |
693 Use the \fBinstalladm\fR command with the \fBcreate-manifest\fR subcommand to add each AI manifest with criteria for selecting that manifest. Each client can use only one AI manifest. |
695 .sp |
694 .sp |
696 .in +2 |
695 .in +2 |
697 .nf |
696 .nf |
698 # \fBinstalladm create-manifest -n \fIai_service_name\fR \e\fR |
697 # \fBinstalladm create-manifest -n \fIsvcname\fR \e\fR |
699 \fB-f \fImanifest_file\fR -m \fImanifest_name\fR \e\fR |
698 \fB-f \fIfilename\fR -m \fImanifest\fR \e\fR |
700 \fB-C \fIcriteria_file\fR\fR |
699 \fB-C \fIcriteriafile\fR\fR |
701 .fi |
700 .fi |
702 .in -2 |
701 .in -2 |
703 .sp |
702 .sp |
704 |
703 |
705 Use the \fBcreate-profile\fR subcommand to add each profile with criteria for selecting that configuration profile. Each client can use one or more system configuration profiles. |
704 Use the \fBcreate-profile\fR subcommand to add each profile with criteria for selecting that configuration profile. Each client can use one or more system configuration profiles. |
706 .sp |
705 .sp |
707 .in +2 |
706 .in +2 |
708 .nf |
707 .nf |
709 # \fBinstalladm create-profile -n \fIai_service_name\fR \e\fR |
708 # \fBinstalladm create-profile -n \fIsvcname\fR \e\fR |
710 \fB-f \fIprofile_file\fR -p \fIprofile_name\fR \e\fR |
709 \fB-f \fIfilename\fR -p \fIprofile\fR \e\fR |
711 \fB-C \fIcriteria_file\fR\fR |
710 \fB-C \fIcriteriafile\fR\fR |
712 .fi |
711 .fi |
713 .in -2 |
712 .in -2 |
714 .sp |
713 .sp |
715 |
714 |
716 See the AI documentation and the \fBinstalladm\fR(1M) man page for information about configuring AI install services. |
715 See the AI documentation and the \fBinstalladm\fR(1M) man page for information about configuring AI install services. |
893 .SH FILES |
892 .SH FILES |
894 .sp |
893 .sp |
895 .ne 2 |
894 .ne 2 |
896 .mk |
895 .mk |
897 .na |
896 .na |
898 \fB\fB\fIoutput_directory\fR/AI_${\fIprofile_name\fR}\fR\fR |
897 \fB\fB\fIoutputdir\fR/AI_${\fIprofile\fR}\fR\fR |
899 .ad |
898 .ad |
900 .sp .6 |
899 .sp .6 |
901 .RS 4n |
900 .RS 4n |
902 Directory that contains all the corresponding files that have been translated to the new AI syntax associated with the profile. |
901 Directory that contains all the corresponding files that have been translated to the new AI syntax associated with the profile. |
903 .RE |
902 .RE |
904 |
903 |
905 .sp |
904 .sp |
906 .ne 2 |
905 .ne 2 |
907 .mk |
906 .mk |
908 .na |
907 .na |
909 \fB\fB\fIoutput_directory\fR/AI_${\fIprofile_name\fR}.${\fIarch\fR}.xml\fR\fR |
908 \fB\fB\fIoutputdir\fR/AI_${\fIprofile\fR}.${\fIarch\fR}.xml\fR\fR |
910 .ad |
909 .ad |
911 .sp .6 |
910 .sp .6 |
912 .RS 4n |
911 .RS 4n |
913 The manifest file created as a result of translating the profile. \fB${\fIarch\fR}\fR can be one of these three values: \fBsparc\fR, \fBx86\fR, or \fBgeneric\fR. A manifest file that is in the form \fB${\fIprofile_name\fR}.generic.xml\fR can be used to install both x86 and SPARC systems. |
912 The manifest file created as a result of translating the profile. \fB${\fIarch\fR}\fR can be one of these three values: \fBsparc\fR, \fBx86\fR, or \fBgeneric\fR. A manifest file that is in the form \fB${\fIprofile\fR}.generic.xml\fR can be used to install both x86 and SPARC systems. |
914 .RE |
913 .RE |
915 |
914 |
916 .sp |
915 .sp |
917 .ne 2 |
916 .ne 2 |
918 .mk |
917 .mk |
919 .na |
918 .na |
920 \fB\fB\fIoutput_directory\fR/AI_${\fIprofile_name\fR}/criteria-\fIrule_number\fR.xml\fR\fR |
919 \fB\fB\fIoutputdir\fR/AI_${\fIprofile\fR}/criteria-\fIrule\fR.xml\fR\fR |
921 .ad |
920 .ad |
922 .sp .6 |
921 .sp .6 |
923 .RS 4n |
922 .RS 4n |
924 The \fBcriteria-\fIrule_number\fR.xml\fR file produced corresponds to the rule in the \fBrules\fR file, and the \fB\fIrule_number\fR\fR is the rule number based on its position in the \fBrules\fR file. This criteria file can then be used with the \fB-C\fR option to the \fBinstalladm\fR command. |
923 The \fBcriteria-\fIrule\fR.xml\fR file produced corresponds to the rule in the \fBrules\fR file. The \fB\fIrule\fR\fR is the rule number based on its position in the \fBrules\fR file. This criteria file can then be used with the \fB-C\fR option to the \fBinstalladm\fR command. |
925 .sp |
924 .sp |
926 Since more than one rule can specify the same profile, more than one criteria file can exist in each directory, but only one instance of the \fB${\fIprofile_name\fR}.${\fIarch\fR}.xml\fR file should exist in each output directory. |
925 Since more than one rule can specify the same profile, more than one criteria file can exist in each directory, but only one instance of the \fB${\fIprofile\fR}.${\fIarch\fR}.xml\fR file should exist in each output directory. |
927 .LP |
926 .LP |
928 Note - |
927 Note - |
929 .sp |
928 .sp |
930 .RS 2 |
929 .RS 2 |
931 If the \fB-p\fR option is used, no criteria file is produced for the profile that is processed. Criteria files are only generated when used with the \fB-r\fR option. |
930 If the \fB-p\fR option is used, no criteria file is produced for the profile that is processed. Criteria files are only generated when used with the \fB-r\fR option. |
932 .RE |
931 .RE |
933 .RE |
932 .RE |
934 |
933 |
935 .sp |
934 .sp |
936 .ne 2 |
935 .ne 2 |
937 .mk |
936 .mk |
938 .na |
937 .na |
939 \fB\fB\fIoutput_directory\fR/js2ai.err\fR\fR |
938 \fB\fB\fIoutputdir\fR/js2ai.err\fR\fR |
940 .ad |
939 .ad |
941 .sp .6 |
940 .sp .6 |
942 .RS 4n |
941 .RS 4n |
943 This file contains a stack trace of an unexpected condition that occurred during processing. This file is not typically created. |
942 This file contains a stack trace of an unexpected condition that occurred during processing. This file is not typically created. |
944 .RE |
943 .RE |
945 |
944 |
946 .sp |
945 .sp |
947 .ne 2 |
946 .ne 2 |
948 .mk |
947 .mk |
949 .na |
948 .na |
950 \fB\fB\fIoutput_directory\fR/js2ai.log\fR\fR |
949 \fB\fB\fIoutputdir\fR/js2ai.log\fR\fR |
951 .ad |
950 .ad |
952 .sp .6 |
951 .sp .6 |
953 .RS 4n |
952 .RS 4n |
954 This file contains a log of the files processed and any errors found during processing. |
953 This file contains a log of the files processed and any errors found during processing. |
955 .RE |
954 .RE |
956 |
955 |
957 .sp |
956 .sp |
958 .ne 2 |
957 .ne 2 |
959 .mk |
958 .mk |
960 .na |
959 .na |
961 \fB\fB\fIoutput_directory\fR/sc_profile.xml\fR\fR |
960 \fB\fB\fIoutputdir\fR/sc_profile.xml\fR\fR |
962 .ad |
961 .ad |
963 .sp .6 |
962 .sp .6 |
964 .RS 4n |
963 .RS 4n |
965 This file is the SMF system configuration profile that is generated when the \fB-s\fR option is used to convert a \fBsysidcfg\fR file. |
964 This file is the SMF system configuration profile that is generated when the \fB-s\fR option is used to convert a \fBsysidcfg\fR file. |
966 .RE |
965 .RE |